Create and Manage Customer Profiles

The unique ID assigned to each customer tag which is generated by our system using the ULID format. Each ID is precisely 26 characters long, ensuring a unique and consistent identifier for every customer tag. This ULID is automatically created by our system and is used to uniquely identify and track each customer tag in our database.

This attribute serves as the identifier or label for the group. It's a concise and clear title that represents the essence of the group. For instance, a name could be 'Frequent Buyers' or 'Newsletter Subscribers'. This attribute should be chosen to reflect the common characteristic or purpose that links the customers in this tag, making it easy to identify and reference the group at a glance. Please notice that duplicate values are not allowed and it's allowed to use alpha dash only [A-Za-z0-9-_ ].

This value indicates whether the customer tag is active or not. This flag can be used to control the customer tag's availability in runtime environments or listings without deleting or removing the customer tag from records. A true value means the customer tag is active and functioning, while a false value implies that the customer tag is deactivated or not in use.

It's a unique identifier assigned to each customer tag. It's primary role is to distinguish one customer tag from another, ensuring that each customer tag can be individually tracked and managed without any confusion. Please notice that duplicate values are not allowed and it's allowed to use alpha dash only [A-Za-z0-9-_]. The reference_id value is used to Identify Resource when you consume any customer tag endpoint with sending identify_by query parameter with value reference_id.

This attribute provides more detailed information about the customer tag. It's where you can explain the purpose or characteristics of the group in more depth. For example, for a tag named 'Frequent Buyers', the description might elaborate on criteria like “Customers who make purchases more than twice a month.” This attribute is particularly useful for understanding the context and nuances of the customer group, guiding how you interact with and cater to this segment.

The customer tag metadata model details. Metadata serves as a tool for keeping extra, organized details about a resource. For example, you can use it to store a user's preferences like prefered color, notes or any other data that aids in personalizing services, improving customer relations, or optimizing internal workflows. This information isn't utilized by Payiano – meaning it's not involved in authorizing or declining transactions and remains invisible to your users. Its value is entirely private for your internal use, and we ensure it remains confidential, not shared with any external parties.

This value indicates whether the customer tag is deleted or not. This flag can be used to control the customer tag's availability in runtime without actual deleting or removing the customer tag from records. A true value means the customer tag is deleted, while a false value implies that the customer tag is not deleted and functioning.

The created datetime of the customer tag. This attribute can be formatted as an ISO 8601 string or a UNIX timestamp in milliseconds, depending on the preferred datetime format specified in the request header (e.g., 2024-08-04T14:22:01Z or 1722572118554). By default, the format is UNIX timestamp in milliseconds.

The updated datetime of the customer tag. This attribute can be formatted as an ISO 8601 string or a UNIX timestamp in milliseconds, depending on the preferred datetime format specified in the request header (e.g., 2024-08-04T14:22:01Z or 1722572118554). By default, the format is UNIX timestamp in milliseconds.

This array consists of objects, each containing a key and a value. These pairs of key-value are structured in a way that's more suitable for programmatic access. You can add up to 50 objects.

The unique ID assigned to each customer address which is generated by our system using the ULID format. Each ID is precisely 26 characters long, ensuring a unique and consistent identifier for every customer address. This ULID is automatically created by our system and is used to uniquely identify and track each customer address in our database.

Specify the unique two-letter country code ( e.g EG, SA or AE ) corresponding to the country where customer is located. This code is part of the standard international country codes set by the ISO .

This attribute is used to differentiates between types of customer addresses, such as billing or shipping address.

This attribute specifies if the address is the default one selected for the customer for billing or shipping purposes. It comes into play when the user is directed to the checkout page or when an order is being delivered to them.

It's a unique identifier assigned to each customer address. It's primary role is to distinguish one customer address from another, ensuring that each customer address can be individually tracked and managed without any confusion. Please notice that duplicate values are not allowed and it's allowed to use alpha dash only [A-Za-z0-9-_]. The reference_id value is used to Identify Resource when you consume any customer address endpoint with sending identify_by query parameter with value reference_id.

This attribute is the primary address line. This is where the first part of the address is written, usually the house number and street name. It's where the mail starts to find where you live or work.

An optional secondary address line used for additional information like apartment, suite, or building numbers that help refine the location for delivery services.

This attribute specifies the city in which the address is located. It's essential for routing mail and deliveries within the correct geographical area.

The state or region attribute further narrows down the location, especially in countries with large geographical areas divided into states, provinces, or regions.

Also known as postal code in some regions, this numeric or alphanumeric code is critical for sorting mail and determining delivery routes with precision.

A primary contact number that can be a mobile or cellular number, providing a direct line to the individual or entity associated with the address.

An alternative to the mobile number, this is a fixed-line telephone number associated with the location, useful for contact purposes where mobile signals may be unreliable.

Not used as much these days, but it's a number where you can receive documents sent over a telephone line.

The given name of the individual associated with the address, important for personalizing communication and ensuring the correct recipient for mail or services.

The family or surname of the individual, completing the personal identification and used in conjunction with the first name for full clarity on the recipient's identity.

This value indicates whether the customer address is deleted or not. This flag can be used to control the customer address's availability in runtime without actual deleting or removing the customer address from records. A true value means the customer address is deleted, while a false value implies that the customer address is not deleted and functioning.

This attribute is used to offer a precise, geographical identification of a place, which is crucial for various applications like mapping, navigation, and location-based services.

This free-text field allows for additional information or special instructions related to the address or delivery preferences to be included.

This field is the key to associating each address with the correct customer account, enhancing the personalization and accuracy of the transaction process. It's not only enhances transaction precision but also contributes significantly to effective customer relationship management and data analysis.

This attribute is used to offer a precise, geographical identification of a place, which is crucial for various applications like mapping, navigation, and location-based services.

The created datetime of the customer address. This attribute can be formatted as an ISO 8601 string or a UNIX timestamp in milliseconds, depending on the preferred datetime format specified in the request header (e.g., 2024-08-04T14:22:01Z or 1722572118554). By default, the format is UNIX timestamp in milliseconds.

The updated datetime of the customer address. This attribute can be formatted as an ISO 8601 string or a UNIX timestamp in milliseconds, depending on the preferred datetime format specified in the request header (e.g., 2024-08-04T14:22:01Z or 1722572118554). By default, the format is UNIX timestamp in milliseconds.

The unique ID assigned to each customer address which is generated by our system using the ULID format. Each ID is precisely 26 characters long, ensuring a unique and consistent identifier for every customer address. This ULID is automatically created by our system and is used to uniquely identify and track each customer address in our database.

Specify the unique two-letter country code ( e.g EG, SA or AE ) corresponding to the country where customer is located. This code is part of the standard international country codes set by the ISO .

This attribute is used to differentiates between types of customer addresses, such as billing or shipping address.

This attribute specifies if the address is the default one selected for the customer for billing or shipping purposes. It comes into play when the user is directed to the checkout page or when an order is being delivered to them.

It's a unique identifier assigned to each customer address. It's primary role is to distinguish one customer address from another, ensuring that each customer address can be individually tracked and managed without any confusion. Please notice that duplicate values are not allowed and it's allowed to use alpha dash only [A-Za-z0-9-_]. The reference_id value is used to Identify Resource when you consume any customer address endpoint with sending identify_by query parameter with value reference_id.

This attribute is the primary address line. This is where the first part of the address is written, usually the house number and street name. It's where the mail starts to find where you live or work.

An optional secondary address line used for additional information like apartment, suite, or building numbers that help refine the location for delivery services.

This attribute specifies the city in which the address is located. It's essential for routing mail and deliveries within the correct geographical area.

The state or region attribute further narrows down the location, especially in countries with large geographical areas divided into states, provinces, or regions.

Also known as postal code in some regions, this numeric or alphanumeric code is critical for sorting mail and determining delivery routes with precision.

A primary contact number that can be a mobile or cellular number, providing a direct line to the individual or entity associated with the address.

An alternative to the mobile number, this is a fixed-line telephone number associated with the location, useful for contact purposes where mobile signals may be unreliable.

Not used as much these days, but it's a number where you can receive documents sent over a telephone line.

The given name of the individual associated with the address, important for personalizing communication and ensuring the correct recipient for mail or services.

The family or surname of the individual, completing the personal identification and used in conjunction with the first name for full clarity on the recipient's identity.

This value indicates whether the customer address is deleted or not. This flag can be used to control the customer address's availability in runtime without actual deleting or removing the customer address from records. A true value means the customer address is deleted, while a false value implies that the customer address is not deleted and functioning.

This attribute is used to offer a precise, geographical identification of a place, which is crucial for various applications like mapping, navigation, and location-based services.

This free-text field allows for additional information or special instructions related to the address or delivery preferences to be included.

This field is the key to associating each address with the correct customer account, enhancing the personalization and accuracy of the transaction process. It's not only enhances transaction precision but also contributes significantly to effective customer relationship management and data analysis.

This attribute is used to offer a precise, geographical identification of a place, which is crucial for various applications like mapping, navigation, and location-based services.

The created datetime of the customer address. This attribute can be formatted as an ISO 8601 string or a UNIX timestamp in milliseconds, depending on the preferred datetime format specified in the request header (e.g., 2024-08-04T14:22:01Z or 1722572118554). By default, the format is UNIX timestamp in milliseconds.

The updated datetime of the customer address. This attribute can be formatted as an ISO 8601 string or a UNIX timestamp in milliseconds, depending on the preferred datetime format specified in the request header (e.g., 2024-08-04T14:22:01Z or 1722572118554). By default, the format is UNIX timestamp in milliseconds.