Sign in
latestOpenAPI 3.0.12026-08-101292701.1 MB

f21981db32be

Subscriptions

Gets a Subscription by ID

Retrieves the details of a Subscription.

get/subscriptions/{id}

Path parameters

idstring required

Subscription identifier.

Response

OK.

contractBindingUntilstring date-time

Represents the date and time when the subscription's contract expires.

createdTimestring date-time

The time when the Subscription was created

updatedTimestring date-time

The time when the Subscription was last updated.

liveModeboolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

idstring

The unique identifier of the Subscription.

billingAgreementIdstring

The billing agreement identifier that is obtained from the subscription's acquisition order.

customerIdstring nullable

The Customer identifier that is obtained from the subscription's acquisition order.

sourceIdstring

The unique identifier of the subscription's reusable payment source.

taxInclusiveboolean

If true indicates that the prices supplied are tax inclusive.

currencystring required

Three-letter ISO currency code (e.g. "USD" or "EUR").

planIdstring required

The Plan identifier.

applicationIdstring nullable

The identifier of the client application that created the subscription.

localestring nullable

A locale designator that combines a two-letter ISO 639-1 language code with a ISO 3166-1 alpha-2 country code.

state'draft' | 'activePendingInvoice' | 'active' | 'activeFree' | 'failed' | 'cancelled' | 'ended' | 'lapsed'

The state of the subscription

currentPeriodStartDatestring date-time

Represents the date and time when the subscription's current billing period began.

currentPeriodEndDatestring date-time

Represents the date and time when the subscription's current billing period ends.

nextInvoiceDatestring date-time

Represents the date and time when Digital River next opens an invoice and starts the billing process.

nextReminderDatestring date-time

Date when the next reminder event will be sent.

metadataMetadata

Key-value pairs used to store additional data. Value can be string, boolean or integer types.

Example response

{
  "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"
  }
}