v1

latestOpenAPI 3.0.12026-07-242871595.3 MB

SUBSCRIPTIONS

Get subscriptions under a plan

Retrieves subscriptions under a plan. Merchants can create subscriptions that associate customers with specific plans, including details such as customer billing information, card-on-file, scheduled payment amount, start date, and payment intervals.

get/v1/plans/{planId}/subscriptions

Path parameters

planIdstring required

Universally unique identifier (UUID) of the plan with subscriptions.

Query parameters

customerUuidsstring[]

Universally unique identifier (UUID) of the customer.

startDateGtinteger

Subscription start date greater than value. Must be in the future. Default: Next day.

startDateLtinteger

Subscription start date less than value.

endDateGtinteger

Subscription end date greater than value.

endDateLtinteger

Subscription end date less than value.

activeboolean

Indicates whether the subscription is currently active. Values: True False

sortstring

Indicates sort order value for the subscription. Default: Name

limitinteger

Plan limit. Minimum value: 10

offsetinteger

Plan offset value. Default: 0

Headers

X-Clover-Merchant-Idstring required

Clover merchant identifier (mId).

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <application>/<version>

Response

Successful response. All subscriptions in a plan are displayed.

objectstring

Subscription object.

idstring UUID

Subscription identifier.

customerUuidstring uuid

Customer universally unique identifier (UUID).

collectionMethod'CHARGE_AUTOMATICALLY' | 'AUTHORIZE_AUTOMATICALLY' | 'SEND_INVOICE'

Method for collecting payment. Currently, charge_automatically is the only method allowed.

merchantIdstring uuid

Merchant identifier (ID) who applied for the subscription plan.

activeboolean

Indicates whether the merchant business is active or not. Values:

True
False

tipAmountinteger

Tip amount.

amountinteger

Amount of subscription.

startDatestring date-time

Start date of the subscription plan in ISO-8601 format. For example, September 7, 2019 displays as 20190907 or expressed with delimiters as 2019-09-07. Time displays in hours, minutes, and seconds, as 12:07:22.

endDatestring date-time

End date of the subscription plan in ISO-8601 format. For example, September 7, 2019 displays as 20190907 or expressed with delimiters as 2019-09-07. Time displays in hours, minutes, and seconds, as 12:07:22.

notestring

Subscription note, if any.

lastRunDatestring date-time

Last run date of subscription.

createdTimestring date-time

Time when subscription was created.

modifiedTimestring date-time

Time when subscription was modified.

deletedTimestring date-time

Time when subscription was deleted.

taxRateUuidsstring[]

Tax rate universally unique identifier (UUID) for the plan.

Example response

[
  {
    "collectionMethod": "CHARGE_AUTOMATICALLY",
    "note": "note",
    "modifiedTime": "2000-01-23T04:56:07.000Z",
    "amount": 5,
    "tipAmount": 5,
    "endDate": "2000-01-23T04:56:07.000Z",
    "active": true,
    "softDescriptor": {
      "merchantContactInfo": "merchantContactInfo",
      "city": "city",
      "street": "street",
      "countryCode": "countryCode",
      "postalCode": "postalCode",
      "dbaName": "dbaName",
      "region": "region"
    },
    "lastRunDate": "2000-01-23T04:56:07.000Z",
    "taxRateUuids": [
      "taxRateUuids",
      "taxRateUuids"
    ],
    "customerUuid": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "merchantId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "createdTime": "2000-01-23T04:56:07.000Z",
    "id": "id",
    "deletedTime": "2000-01-23T04:56:07.000Z",
    "plan": {
      "note": "note",
      "modifiedTime": "2000-01-23T04:56:07.000Z",
      "amount": 6,
      "tipAmount": 0,
      "active": true,
      "uuid": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "taxRateUuids": [
        "taxRateUuids",
        "taxRateUuids"
      ],
      "productUuid": "productUuid",
      "merchantId": "merchantId",
      "intervalCount": 1,
      "name": "name",
      "createdTime": "2000-01-23T04:56:07.000Z",
      "interval": "DAY",
      "id": "id",
      "deletedTime": "2000-01-23T04:56:07.000Z"
    },
    "startDate": "2000-01-23T04:56:07.000Z",
    "object": "object",
    "level2": {
      "vatTaxRate": 9,
      "freightAmount": 2,
      "pcOrderNumber": "pcOrderNumber",
      "destinationCountryCode": "destinationCountryCode",
      "discountAmount": 3,
      "purchaseIdentifier": "purchaseIdentifier",
      "shipFromPostalCode": "shipFromPostalCode",
      "taxIndicator": "UNKNOWN",
      "destinationPostalCode": "destinationPostalCode",
      "merchantTaxId": "merchantTaxId",
      "vatTaxAmount": 7,
      "taxAmount": 2,
      "dutyAmount": 4,
      "productDescription": "productDescription"
    }
  }
]