Subscriptions

Subscriptions represent a product, product edition or service that will be billed for on the defined recurrence period.

idstring

The order id which is unique to a specific product subscription.

Example: Of-60341002-c558-484c-a7fe-e1vr97eadbg3

typestring

Type of the data that is returned.

Default value: subscriptions

attributes object

customerIdstring

The id of the business location.

Example: AG-1234567

productNamestring

The name of the product that the subscription is assigned for.

Example: Website Pro

skustring

The unique identifier of a product, product edition or package. It can be obtained by following this guide. This value is used when placing an order.

Example: A-H73ELH2OP6

customerNamestring

The name of the customer (Business).

Example: Kurry Cart

billingStartstring

The date/time when the item starts billing.

frequencystring

The frequency for which the product is billed.

Example: monthly

nextRenewalstring

The calculated next renewal date of the item.

Subscriptions

{
  "id": "Of-60341002-c558-484c-a7fe-e1vr97eadbg3",
  "type": "subscriptions",
  "attributes": {
    "customerId": "AG-1234567",
    "productName": "Website Pro",
    "sku": "A-H73ELH2OP6",
    "customerName": "Kurry Cart",
    "billingStart": "string",
    "frequency": "monthly",
    "nextRenewal": "string"
  }
}