🔒 Requires read-customers or write-customers access scope.

{} The subscriber's object

{
    "id": "6964807663890",
    "email": "[email protected]",
    "first_name": "cheeeeeeta",
    "last_name": "Rao",
    "phone": "+12025550151",
    "total_spent": 0,
    "note": "",
    "addresses": [
        {
            "first_name": "tony",
            "last_name": "stark",
            "email": "[email protected]",
            "phone": "+12025550151",
            "address1": "Avengers Tower",
            "address2": null,
            "company": null,
            "city": "Los Angeles",
            "zip": "91335",
            "province": "California",
            "country": "United States"
        },
        {
            "first_name": "cheetos",
            "last_name": "r",
            "email": "[email protected]",
            "phone": "+12025550151",
            "address1": "17718 Sherman Way",
            "address2": null,
            "company": null,
            "city": "Los Angeles",
            "zip": "91335",
            "province": "California",
            "country": "United States"
        }
    ],
    "default_address": {
        "first_name": "cheetos",
        "last_name": "r",
        "email": "[email protected]",
        "phone": "+12025550151",
        "address1": "17718 Sherman Way",
        "address2": null,
        "company": null,
        "city": "Los Angeles",
        "zip": "91335",
        "province": "California",
        "country": "United States"
    },
    "channel": "ecommerce",
    "meta": [],
    "created_at": "2024-07-04 08:18:35",
    "updated_at": "2024-07-04 08:18:42"
}

The subscriber resource

Attribute	Type	Description
id	integer`readonly`	An unsigned 64-bit integer that's used as a unique identifier for the subscriber. Each id is unique across the Recurpay system. No two subscribers will have the same id, even if they're from different stores.
email	string	The unique email address of the subscriber. Attempting to assign the same email address to multiple subscribers returns an error.
first_name	string	The subscriber's first name.
last_name	string	The subscriber's last name.
phone	string	The unique phone number (E.164 format) for this subscriber. Attempting to assign the same phone number to multiple subscribers returns an error. The property can be set using different formats, but each format must represent a number that can be dialed from anywhere in the world. The following formats are all valid: 6135551212 +16135551212 (613)555-1212 +1 613-555-1212
total_spent	string `readonly`	The total revenue of the subscription associated with this subscriber.
note	string	A note about the subscriber.
addresses	array	A list of the five most recently updated addresses for the subscriber. Each address has the following properties: view
default_address	object	The default address for the subscriber. The default address has the following properties: view
channel	string `readonly`	The subscriber's source. The following channels are available: ecommerce if the subscriber's source is your ecommerce platform. recurpay if the subscriber's sales source is recurpay. button if the subscriber's sales source is from a button.
meta	array	Attaches additional metadata to a subscriber's resources.
created_at	string`readonly`	The autogenerated date and time (ISO 8601 format) when the subscriber was created in Recurpay.
updated_at	string`readonly`	The date and time (ISO 8601 format) when the subscriber was last modified.

Address

Attribute	Type	Description
first_name	string	The subscriber's first name.
last_name	string	The subscriber's last name.
email	string	The email address of the subscriber.
phone	string	The subscriber's phone number at this address.
address1	string	The first line of the subscriber's mailing address.
address2	string	An additional field for the subscriber's mailing address.
company	string	The subscriber's company.
city	string	The subscriber's city, town, or village.
zip	string	The subscriber's postal code, also known as zip, postcode, Eircode, etc.
province	string	The subscriber's region name. Typically a province, a state, or a prefecture.
country	string	The subscriber's country.