FirmhouseSubscription
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
|
| The date and time when the subscription was activated and billing started. | - |
|
| Returns the plan the subscription is currently subscribed to. |
|
|
| The customer's full address line or just street. Can include houseNumber if not separately stored in houseNumber field. |
|
|
| The amount that is due on checkout (in cents). |
|
|
| List of all applied promotions for this customer. |
|
|
| The customer's billing address address line or street. |
|
|
| The customer's billing address city or town. |
|
|
| The company name of the customer's billing address. |
|
|
| The customer's billing address country code (ISO3661). |
|
|
| The customer's billing address district. |
|
|
| The customer's billing address full address by combining address and house number. |
|
|
| The customer's billing address full name. |
|
|
| The customer's billing address house, building, or appartment number. |
|
|
| The customer's billing address last name. |
|
|
| The customer' billing address first name. |
|
|
| The customer's billing address phone number (international format). |
|
|
| The customer's billing address salutation (mr,ms,mx). |
|
|
| The customer's billing address state or province (ISO3661-2). |
|
|
| The customer's billing address zip code or postal code. |
|
|
| The date and time when cancellation was initiated for the subscription (in case of two-step cancellation). | - |
|
| The date and time when the subscription was cancelled. | - |
|
| The day of the month when the customer is charged. |
|
|
| URL for the customers to complete their draft subscription. |
|
|
| The customer's city or town. |
|
| List of collection cases for this customer | - | |
|
| The customer's company name. |
|
|
| The customer's country code (ISO 3116) |
|
|
| The date and time when the subscription record was first created. |
|
|
| The currency used for this subscription |
|
|
| The customer ID given by the selected payment provider |
|
|
| The field that can be used for your internal reference. For example, internal customer id. |
|
|
| The customer's date of birth |
|
|
| Whether billing and shipping addresses are the same. Set this flag to |
|
|
| The customer's district |
|
|
| The customer's email address |
|
| List of extra fields and values. |
| |
|
| The customer's full address by combining address and house number. |
|
|
| The customer's full name. |
|
|
| The customer's house number. |
|
|
| The id of the subscription. | |
|
| Identity verification URL that automatically uses the configured provider.Append ?return_url=https://your-url to send the customer back after a successful identification. |
|
|
| Whether this subscription is currently in its trial period. | - |
|
| List of invoices of this customer. | - |
|
| The customer's last name. |
|
|
| The customer's locale/language. |
|
|
| The date and time when the subscription was last marked as non-paying. | - |
|
| Whether the customer accepted the optional marketing opt-in. |
|
|
| Metadata makes it possible to store additional information on objects. |
|
|
| The monthly amount that is charged. |
|
|
| The customer's first name. |
|
|
| Notes about the customer that can be set in the portal | - |
|
| The ordered products that are part of the order |
|
| List of orders of this subscription | - | |
|
| The amount that is succesfully paid so far. | - |
|
| The time the subscription was paused. | - |
|
| The time the subscription will be automatically resumed. | - |
|
| The payment method currently in use for billing | - |
|
| The last 4 digits of the current payment method. | - |
|
| Localised string of the payment method currently in use for billing. | - |
|
| The customer's full international phone number |
|
|
| The payment method details returned by PSP currently used for billing. | - |
|
| The customer's salutation (mr,ms,mx). |
|
|
| The date and time when the subscription completed their signup and made their initial payment (or no payment if free). | - |
|
| If true then the subscription won't be activated after signup and initial payment. | - |
|
| The date and time when this subscription was (or will be) charged for the first time. |
|
|
| The customer's state |
|
| Status of this customer. |
| |
|
| The date and time when the subscription was automatically stopped. | - |
|
| Returns the plan relationship and contract terms of the current plan |
|
|
| Whether the customer accepted the terms and conditions. |
|
|
| Whether the customer has accepted the terms&conditions. |
|
|
| Unique token of the subscription |
|
|
| The number of months before customer is charged for the first time. |
|
|
| Send your customer to this URL to allow them to update their active payment method. | - |
|
| The date and time when the subscription was last updated. |
|
|
| The company's VAT number. |
|
|
| Details of the verified identity if present. | - |
|
| The customer's postal code or zipcode. |
|
Last updated