Sign in
latestOpenAPI 3.0.12026-08-101292701.1 MB

f21981db32be

Subscriptions

Returns a list of Subscriptions

Gets the Subscriptions specified in the request.

get/subscriptions

Query parameters

planIdstring

The identifier of the plan associated with the subscriptions you want to retrieve.

statestring

The state associated with the subscriptions you want to retrieve.

customerIdstring

The identifer of the subscribing customer of the subscriptions you want to retrieve.

endingBeforestring

A cursor for use in pagination. The endingBefore parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with xzy, your subsequent calls can include endingBefore=xzy in order to fetch the previous page of the list.

startingAfterstring

A cursor for use in pagination. The startingAfter parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with xzy, your subsequent calls can include startingAfter=xzy in order to fetch the next page of the list.

limitinteger

A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.

Response

200 OK

hasMoreboolean

Indicates whether or not there are more elements available after this set. If false this set represents the end of the list.

Example response

{
  "hasMore": true,
  "data": [
    {
      "createdTime": "2021-06-01T13:15:10.1077785Z",
      "updatedTime": "2021-06-01T13:17:10.1077788Z",
      "stateTransitions": {
        "activated": "2018-04-25T20:36:00Z",
        "activatedFree": "2018-04-25T20:36:00Z",
        "failed": "2018-04-25T20:36:00Z",
        "cancelled": "2018-04-25T20:36:00Z",
        "ended": "2018-04-25T20:36:00Z",
        "lapsed": "2018-04-25T20:36:00Z"
      },
      "id": "fb941eef-c3bb-42f8-bd47-f6da8bf6245d",
      "billingAgreementId": "24b217a7-79b5-4c84-8cae-34370646092f",
      "customerId": "exampleCustomerId",
      "sourceId": "exampleSourceId",
      "taxInclusive": true,
      "currency": "EUR",
      "planId": "4a1a1fdd-2f7b-4a4e-92d2-2e843f06e82a",
      "applicationId": "test",
      "locale": "de_DE",
      "state": "active",
      "items": [
        {
          "aggregatePrice": 20,
          "price": 9.99,
          "metadata": {
            "coupon": "iOS"
          },
          "skuId": "1db7a3d6-1f4d-4d13-8ddc-ef4eccc6bd93",
          "productDetails": {
            "id": "100067660336",
            "skuGroupId": "wireless-keyboards",
            "name": "Keyboard",
            "description": "Top rated keyboard",
            "itemBreadcrumb": "Sports & Outdoors > Exercise & Fitness > Wearable Technology > Fitness Trackers",
            "url": "https://producturl.com",
            "countryOfOrigin": "US",
            "image": "https://imageurl.com",
            "weight": 20.5,
            "weightUnit": "oz",
            "partNumber": "SWG1224J10L",
            "partnerAccountId": "00g6atnynbl2wFsFG357"
          },
          "quantity": 1
        }
      ],
      "nextInvoiceDate": "2021-07-02T13:15:10.0875833Z",
      "metadata": {
        "coupon": "iOS"
      }
    }
  ]
}