v1

latestOpenAPI 3.0.02026-08-06363576.8 KB

Customer

Get all subscriptions for a customer

get/customers/{customerReference}/subscriptions/

Path parameters

customerReferencestring required

Customer reference (customer_reference) in your system of customer to return

Response

Successful operation

idinteger

trial_endstring date-time

start_datestring date-time

ended_atstring date-time

active_untilstring date-time

referencestring

descriptionstring

is_on_trialboolean

activeboolean

cancelledboolean

cancel_datestring date-time

metastring json

tokenstring

customerinteger

Example response

[
  {
    "id": 123,
    "reference": "REF-12345",
    "token": "637302f0412e2e11adc0ba21adafcf11",
    "customer": 123,
    "plan": {
      "id": 1,
      "name": "Name of the plan.",
      "alternative_name": "A slightly longer name or more descriptive.",
      "reference": "SKU-1",
      "interval": "day|week|month|year",
      "interval_count": 1,
      "amount": "1.0000",
      "currency": "USD",
      "description": "A longer description.",
      "enabled": true,
      "electronic_only": true,
      "payment_processor": {
        "id": 1,
        "name": "Adyen processor",
        "type": "adyen"
      }
    },
    "billing_logs": [
      {
        "total": "6.99",
        "transaction": {
          "amount": "6.99",
          "currency": "USD"
        }
      }
    ]
  }
]