Subscriptions

The Subscriptions API enables you to manage Subscriptions and Subscription Plans with ease. A Subscription represents a recurring agreement between you and your customer, allowing for regular charges, such as for season cards.

Subscription Plans define specific properties for Subscriptions that are created based on the Plan. These properties include details like pricing and billing intervals, ensuring precise customization of subscription parameters and behavior

Endpoints

The Subscription object

Attributes

_id

Required

string

The ID of the subscription

sellerId

Required

string

The ID of the seller of the subscription

status

Required

string

The status of the subscription

DRAFTACTIVEINCOMPLETECANCELEDARCHIVEDPENDING-CANCELLATION

customerId

Required

string

The ID of the customer of the subscription

planId

Required

string

The ID of the plan of the subscription

currency

Required

string

An ISO 4217 3-character code of the currency

EURUSDGBPAUDCHFTHBILSCOPMXNDKKNOKSEKQARCADISKGTQINRDOPSGDPLNSARTTDZARKYDHKDCZKKRWJPYNZDAEDMADTWDBRLBWPNADKESSCRTRYSZLLSLTZSUGXZMWZWGGHSNGNSLELRDXOF

items

Required

array<any>

The origin information of the subscription

Optional Attributes

Collapse all

customerPaymentMethodId

Optional

string

The ID of the payment method of the subscription

origin

Optional

object

The origin information of the subscription

origin.eventId

Required

string

The ID of the event of the origin

Optional Attributes

Collapse all

origin.shopId

Optional

string

The ID of the shop of the origin

billing

Optional

object

The billing information of the subscription

billing.cycles

Required

array

An array of billing cycles

billing.cycles[].start

Required

string date-time

An ISO timestamp indicating when the billing start is

billing.cycles[].end

Required

string date-time

An ISO timestamp indicating when the billing end is

billing.cycles[].status

Required

string

The status of the billing

FAILEDSCHEDULEDBILLED

Optional Attributes

Collapse all

billing.cycles[].due

Optional

string date-time

An ISO timestamp indicating when the billing due is

billing.cycles[].transactionId

Optional

object

Optional Attributes

Collapse all

billing.cycles[].transactionId.type

Optional

One of

Only one of the following types

billing.cycles[].transactionId.required

Optional

One of

Only one of the following types

consents

Optional

array

An array of granted consents

consents[].type

Required

string

The type of the subscription consent

autorenewal

consents[].granted

Required

string date-time

The date when the consent was granted

payment

Optional

object

The payment of the subscription

payment.anchor

Required

string date-time

The anchor date of the payment

payment.schedules

Required

array

payment.schedules[].status

Required

string

The status of the payment schedule resource

SCHEDULEDPENDINGSUCCEEDEDFAILEDREFUNDED

payment.schedules[].total

Required

number float

The total to be charged of the payment schedule

payment.schedules[].billingCycleId

Required

string

The Billing Cycle ID of the payment schedule

Optional Attributes

Collapse all

payment.schedules[].due

Optional

string date-time

An ISO timestamp indicating when the due of the payment schedule is

payment.schedules[].paymentId

Optional

string

The Payment ID of the payment schedule

payment.schedules[].paymentRequestId

Optional

string

The Payment Request ID of the payment schedule

payment.schedules[].attempts

Optional

array

An array of payment schedule attempts

payment.schedules[].attempts[]._id

Required

string

The ID of the payment schedule attempt

payment.schedules[].attempts[].date

Required

string date-time

The date of the payment schedule attempt

payment.schedules[].attempts[].status

Required

string

The status of the payment schedule attempt

SCHEDULEDPENDINGSUCCEEDEDFAILEDREFUNDED

payment.schedules[].attempts[].paymentRequestId

Required

string

The Payment Request ID of the payment schedule attempt

payment.schedules[].attempts[].paymentMethodId

Required

string

The Payment Method ID of the payment schedule attempt

payment.schedules[].nextAttempt

Optional

string date-time

An ISO timestamp indicating when the next attempt of the payment schedule is

cycles

Optional

array

An array of applied cycles on the subscription

Optional Attributes

Collapse all

cycles[].cycleId

Optional

string

The cycle ID of the applied cycle

cycles[].appliedAt

Optional

string date-time

An ISO timestamp indicating when the cycle was applied

history

Optional

array

An array of history items indicating changes on the subscription

Optional Attributes

Collapse all

history[].type

Optional

string

The type of the history item

subscription.createdsubscription.status_changedsubscription.cycle_appliedsubscription.cycle_failedsubscription.billing_cycle_appliedsubscription.payment_method_changedsubscription.item_changedsubscription.item_deletedsubscription.consent_grantedsubscription.consent_revoked

history[].date

Optional

string date-time

An ISO timestamp indicating the date of the history item

history[].userId

Optional

string

The user ID if the history item comes from a non-subscription-holders

history[].data

Optional

object

The data of the history item

transactionId

Optional

string

The ID of the transaction of the subscription

startAt

Optional

string date-time

An ISO timestamp indicating when the subscription starts

cancelAt

Optional

string date-time

An ISO timestamp indicating when the subscription cancels

canceledAt

Optional

string date-time

An ISO timestamp indicating when the subscription was canceled

company

Optional

string

The company of the subscription holder

firstname

Optional

string

The first name of the subscription holder

lastname

Optional

string

The last name of the subscription holder

name

Optional

string

The name of the subscription holder

Optional

string email

The email of the subscription holder

phone

Optional

string

The phone number of the subscription holder

address

Optional

object

The address information of the subscription holder

Optional Attributes

Collapse all

address.street

Optional

string

The street of the address. Street name including number.

address.line2

Optional

string

The additional field of the address.

address.postal

Optional

string

The postal code of the address.

address.city

Optional

string

The city of the address.

address.country

Optional

string

The country of the address. An ISO 3166 country code.

address.state

Optional

string

The state of the address. If applicable

secret

Optional

string date-time

The secret token of the subscription

attributes

Optional

object

Was this section helpful?

Yes No

{
  "_id": "string",
  "sellerId": "string",
  "status": "DRAFT",
  "customerId": "string",
  "planId": "string",
  "currency": "EUR",
  "customerPaymentMethodId": "string",
  "origin": {
    "eventId": "string",
    "shopId": "string"
  },
  "items": [
    {
      "type": "ticket",
      "_id": "string",
      "name": "string",
      "amount": 1,
      "netPrice": 10.5,
      "price": 10.5,
      "taxRate": 10.5,
      "triggeredBy": "string",
      "bundleInfo": {
        "bundleId": "string",
        "componentId": "string",
        "optionId": "string"
      },
      "ticketTypeId": "string",
      "categoryRef": "string",
      "seatingInfo": {
        "_id": "string",
        "_type": 6,
        "categoryId": "string",
        "statusId": "string",
        "name": "string",
        "seatType": "handicapped",
        "sectionName": "string",
        "groupName": "string",
        "rowName": "string",
        "seatName": "string",
        "gate": "string"
      },
      "slotInfo": {
        "slotId": "string",
        "slotStartTime": "string"
      },
      "asHardTicket": true,
      "listingId": "string",
      "listingItemId": "string",
      "triggeredAutomations": true,
      "meta": {},
      "addOns": [
        {
          "productId": "string",
          "productVariantId": "string",
          "name": "string"
        }
      ],
      "capabilities": [
        {
          "type": "self_service_return",
          "settings": {
            "returnRelatedItems": true,
            "phases": [
              {
                "condition": {
                  "target": "string",
                  "unit": "hours",
                  "offset": 1
                },
                "refundPercentage": 10.5
              }
            ]
          }
        }
      ],
      "taxInfo": {
        "serviceTypeId": "string",
        "exceptionId": "string",
        "proceedsAccountId": "string",
        "proceedsAccountCode": "string",
        "taxItems": [
          {
            "name": "string",
            "taxTypeId": "string",
            "rate": 10.5,
            "perUnit": 10.5,
            "total": 10.5,
            "netTotal": 10.5,
            "netPerUnit": 10.5,
            "taxPayableAccountId": "string",
            "taxPayableAccountCode": "string"
          }
        ]
      },
      "ticketId": "string",
      "planVariantId": "string"
    }
  ],
  "billing": {
    "cycles": [
      {
        "start": "2030-01-23T23:00:00.123Z",
        "end": "2030-01-23T23:00:00.123Z",
        "due": "2030-01-23T23:00:00.123Z",
        "status": "FAILED",
        "transactionId": {
          "type": [],
          "required": []
        }
      }
    ]
  },
  "consents": [
    {
      "type": "autorenewal",
      "granted": "2030-01-23T23:00:00.123Z"
    }
  ],
  "payment": {
    "anchor": "2030-01-23T23:00:00.123Z",
    "schedules": []
  },
  "cycles": [],
  "history": [],
  "transactionId": "string",
  "startAt": "2030-01-23T23:00:00.123Z",
  "cancelAt": "2030-01-23T23:00:00.123Z",
  "canceledAt": "2030-01-23T23:00:00.123Z",
  "company": "string",
  "firstname": "string",
  "lastname": "string",
  "name": "string",
  "email": "[email protected]",
  "phone": "string",
  "address": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string"
  },
  "secret": "2030-01-23T23:00:00.123Z",
  "attributes": {}
}

Get a Subscription

Query

No supported query parameters

200

400

Bad Request

401

Unauthorized

404

Not Found

Was this section helpful?

Yes No

{
  "_id": "string",
  "sellerId": "string",
  "status": "DRAFT",
  "customerId": "string",
  "planId": "string",
  "currency": "EUR",
  "customerPaymentMethodId": "string",
  "origin": {
    "eventId": "string",
    "shopId": "string"
  },
  "items": [
    {
      "type": "ticket",
      "_id": "string",
      "name": "string",
      "amount": 1,
      "netPrice": 10.5,
      "price": 10.5,
      "taxRate": 10.5,
      "triggeredBy": "string",
      "bundleInfo": {
        "bundleId": "string",
        "componentId": "string",
        "optionId": "string"
      },
      "ticketTypeId": "string",
      "categoryRef": "string",
      "seatingInfo": {
        "_id": "string",
        "_type": 6,
        "categoryId": "string",
        "statusId": "string",
        "name": "string",
        "seatType": "handicapped",
        "sectionName": "string",
        "groupName": "string",
        "rowName": "string",
        "seatName": "string",
        "gate": "string"
      },
      "slotInfo": {
        "slotId": "string",
        "slotStartTime": "string"
      },
      "asHardTicket": true,
      "listingId": "string",
      "listingItemId": "string",
      "triggeredAutomations": true,
      "meta": {},
      "addOns": [
        {
          "productId": "string",
          "productVariantId": "string",
          "name": "string"
        }
      ],
      "capabilities": [
        {
          "type": "self_service_return",
          "settings": {
            "returnRelatedItems": true,
            "phases": [
              {
                "condition": {
                  "target": "string",
                  "unit": "hours",
                  "offset": 1
                },
                "refundPercentage": 10.5
              }
            ]
          }
        }
      ],
      "taxInfo": {
        "serviceTypeId": "string",
        "exceptionId": "string",
        "proceedsAccountId": "string",
        "proceedsAccountCode": "string",
        "taxItems": [
          {
            "name": "string",
            "taxTypeId": "string",
            "rate": 10.5,
            "perUnit": 10.5,
            "total": 10.5,
            "netTotal": 10.5,
            "netPerUnit": 10.5,
            "taxPayableAccountId": "string",
            "taxPayableAccountCode": "string"
          }
        ]
      },
      "ticketId": "string",
      "planVariantId": "string"
    }
  ],
  "billing": {
    "cycles": [
      {
        "start": "2030-01-23T23:00:00.123Z",
        "end": "2030-01-23T23:00:00.123Z",
        "due": "2030-01-23T23:00:00.123Z",
        "status": "FAILED",
        "transactionId": {
          "type": [],
          "required": []
        }
      }
    ]
  },
  "consents": [
    {
      "type": "autorenewal",
      "granted": "2030-01-23T23:00:00.123Z"
    }
  ],
  "payment": {
    "anchor": "2030-01-23T23:00:00.123Z",
    "schedules": []
  },
  "cycles": [],
  "history": [],
  "transactionId": "string",
  "startAt": "2030-01-23T23:00:00.123Z",
  "cancelAt": "2030-01-23T23:00:00.123Z",
  "canceledAt": "2030-01-23T23:00:00.123Z",
  "company": "string",
  "firstname": "string",
  "lastname": "string",
  "name": "string",
  "email": "[email protected]",
  "phone": "string",
  "address": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string"
  },
  "secret": "2030-01-23T23:00:00.123Z",
  "attributes": {}
}

Update a Subscription

Payload

secret

Required

string

Optional Attributes

Collapse all

status

Optional

string

The status of the subscription

DRAFTACTIVEINCOMPLETECANCELEDARCHIVEDPENDING-CANCELLATION

customerPaymentMethodId

Optional

string

The ID of the payment method of the subscription

attributes

Optional

object

consents

Optional

array

An array of granted consents

consents[].type

Required

string

The type of the subscription consent

autorenewal

consents[].granted

Required

string date-time

The date when the consent was granted

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "status": "DRAFT",
  "customerPaymentMethodId": "string",
  "attributes": {},
  "consents": [
    {
      "type": "autorenewal",
      "granted": "2030-01-23T23:00:00.123Z"
    }
  ],
  "secret": "string"
}

Get all Subscriptions

Query

top

Optional

number float

A limit on the number of objects to be returned. Can range between 1 and 1000.

skip

Optional

number float

The number of objects to skip for the requested result

customerId

Optional

string

planId

Optional

string

planVariantIds

Optional

array<string>

eventId

Optional

string

customerPaymentMethodId

Optional

string

updatedAt

Optional

object

Optional Attributes

Collapse all

updatedAt.$gt

Optional

string date-time

value is greater than

updatedAt.$gte

Optional

string date-time

value is greater than or equal

updatedAt.$lt

Optional

string date-time

value is less than

updatedAt.$lte

Optional

string date-time

value is less than or equal

updatedAt.$eq

Optional

string date-time

value is equal

updatedAt.$ne

Optional

string date-time

value is not equal

status

Optional

array<string>

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "docs": [
    {
      "_id": "string",
      "sellerId": "string",
      "status": "DRAFT",
      "customerId": "string",
      "planId": "string",
      "currency": "EUR",
      "customerPaymentMethodId": "string",
      "origin": {
        "eventId": "string",
        "shopId": "string"
      },
      "items": [
        {
          "type": "ticket",
          "_id": "string",
          "name": "string",
          "amount": 1,
          "netPrice": 10.5,
          "price": 10.5,
          "taxRate": 10.5,
          "triggeredBy": "string",
          "bundleInfo": {
            "bundleId": "string",
            "componentId": "string",
            "optionId": "string"
          },
          "ticketTypeId": "string",
          "categoryRef": "string",
          "seatingInfo": {
            "_id": "string",
            "_type": 6,
            "categoryId": "string",
            "statusId": "string",
            "name": "string",
            "seatType": "handicapped",
            "sectionName": "string",
            "groupName": "string",
            "rowName": "string",
            "seatName": "string",
            "gate": "string"
          },
          "slotInfo": {
            "slotId": "string",
            "slotStartTime": "string"
          },
          "asHardTicket": true,
          "listingId": "string",
          "listingItemId": "string",
          "triggeredAutomations": true,
          "meta": {},
          "addOns": [
            {
              "productId": "string",
              "productVariantId": "string",
              "name": "string"
            }
          ],
          "capabilities": [
            {
              "type": "self_service_return",
              "settings": {
                "returnRelatedItems": true,
                "phases": [
                  {
                    "condition": {
                      "target": "string",
                      "unit": "hours",
                      "offset": 1
                    },
                    "refundPercentage": 10.5
                  }
                ]
              }
            }
          ],
          "taxInfo": {
            "serviceTypeId": "string",
            "exceptionId": "string",
            "proceedsAccountId": "string",
            "proceedsAccountCode": "string",
            "taxItems": [
              {
                "name": "string",
                "taxTypeId": "string",
                "rate": 10.5,
                "perUnit": 10.5,
                "total": 10.5,
                "netTotal": 10.5,
                "netPerUnit": 10.5,
                "taxPayableAccountId": "string",
                "taxPayableAccountCode": "string"
              }
            ]
          },
          "ticketId": "string",
          "planVariantId": "string"
        }
      ],
      "billing": {
        "cycles": [
          {
            "start": "2030-01-23T23:00:00.123Z",
            "end": "2030-01-23T23:00:00.123Z",
            "due": "2030-01-23T23:00:00.123Z",
            "status": "FAILED",
            "transactionId": {
              "type": [],
              "required": []
            }
          }
        ]
      },
      "consents": [
        {
          "type": "autorenewal",
          "granted": "2030-01-23T23:00:00.123Z"
        }
      ],
      "payment": {
        "anchor": "2030-01-23T23:00:00.123Z",
        "schedules": []
      },
      "cycles": [],
      "history": [],
      "transactionId": "string",
      "startAt": "2030-01-23T23:00:00.123Z",
      "cancelAt": "2030-01-23T23:00:00.123Z",
      "canceledAt": "2030-01-23T23:00:00.123Z",
      "company": "string",
      "firstname": "string",
      "lastname": "string",
      "name": "string",
      "email": "[email protected]",
      "phone": "string",
      "address": {
        "street": "string",
        "line2": "string",
        "postal": "string",
        "city": "string",
        "country": "string",
        "state": "string"
      },
      "secret": "2030-01-23T23:00:00.123Z",
      "attributes": {}
    }
  ],
  "total": 1
}

Update Subscription Items

Payload

secret

Required

string

Optional Attributes

Collapse all

seatingReservationToken

Optional

string

item

Optional

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "secret": "string",
  "seatingReservationToken": "string",
  "item": {
    "type": "ticket",
    "_id": "string",
    "name": "string",
    "amount": 1,
    "netPrice": 10.5,
    "price": 10.5,
    "taxRate": 10.5,
    "triggeredBy": "string",
    "bundleInfo": {
      "bundleId": "string",
      "componentId": "string",
      "optionId": "string"
    },
    "ticketTypeId": "string",
    "categoryRef": "string",
    "seatingInfo": {
      "_id": "string",
      "_type": 6,
      "categoryId": "string",
      "statusId": "string",
      "name": "string",
      "seatType": "handicapped",
      "sectionName": "string",
      "groupName": "string",
      "rowName": "string",
      "seatName": "string",
      "gate": "string"
    },
    "slotInfo": {
      "slotId": "string",
      "slotStartTime": "string"
    },
    "asHardTicket": true,
    "listingId": "string",
    "listingItemId": "string",
    "triggeredAutomations": true,
    "meta": {},
    "addOns": [
      {
        "productId": "string",
        "productVariantId": "string",
        "name": "string"
      }
    ],
    "capabilities": [
      {
        "type": "self_service_return",
        "settings": {
          "returnRelatedItems": true,
          "phases": [
            {
              "condition": {
                "target": "string",
                "unit": "hours",
                "offset": 1
              },
              "refundPercentage": 10.5
            }
          ]
        }
      }
    ],
    "taxInfo": {
      "serviceTypeId": "string",
      "exceptionId": "string",
      "proceedsAccountId": "string",
      "proceedsAccountCode": "string",
      "taxItems": [
        {
          "name": "string",
          "taxTypeId": "string",
          "rate": 10.5,
          "perUnit": 10.5,
          "total": 10.5,
          "netTotal": 10.5,
          "netPerUnit": 10.5,
          "taxPayableAccountId": "string",
          "taxPayableAccountCode": "string"
        }
      ]
    },
    "ticketId": "string",
    "planVariantId": "string"
  }
}

The Subscription Plan object

Attributes

_id

Required

string

The ID of the subscription plan

name

Required

string

The name of the subscription plan

sellerId

Required

string

The ID of the seller of the subscription plan

Optional Attributes

Collapse all

pricingPolicy

Optional

string

The pricing policy of the subscription plan

fixedinherited

variants

Optional

array

An array of variants of the subscription plan

variants[]._id

Required

string

The ID of the plan variant

variants[].name

Required

string

The name of the plan variant

Optional Attributes

Collapse all

variants[].canChangeVariant

Optional

boolean

Whether the variant is changeable or not

variants[].allowedVariants

Optional

array<string>

Allowed variants to change of the variant

billingCycle

Optional

object

The billing plan of the subscription plan

billingCycle.scheme

Required

string

The scheme of the billing cycle

one-offrecurring

Optional Attributes

Collapse all

billingCycle.interval

Optional

string

The interval of the billing cycle

DAYWEEKMONTH

billingCycle.every

Optional

number float

The recurrence of the billing cycle

billingCycle.minimumIntervals

Optional

number float

paymentSchedules

Optional

array

An array of payment plans of the subscription plan

paymentSchedules[]._id

Required

string

Optional Attributes

Collapse all

paymentSchedules[].scheme

Optional

string

The scheme of the payment

one-offinstallments

paymentSchedules[].interval

Optional

string

The interval of the payment

DAYWEEKMONTH

paymentSchedules[].numberOfInstallments

Optional

number float

The number of installments of the payment

renewalPolicy

Optional

object

The renewal policy of the subscription plan

Optional Attributes

Collapse all

renewalPolicy.changesPeriodStart

Optional

string date-time

An ISO timestamp indicating when the changes period starts

renewalPolicy.changesPeriodEnd

Optional

string date-time

An ISO timestamp indicating when the changes period ends

renewalPolicy.allowedChanges

Optional

object

Allowed Changes settings of the renewal policy

Optional Attributes

Collapse all

renewalPolicy.allowedChanges.ticketType

Optional

boolean

Whether changes of ticketTypes are allowed or not

renewalPolicy.allowedChanges.seat

Optional

boolean

Whether changes of seats are allowed or not

renewalPolicy.confirmationPeriodStart

Optional

string date-time

An ISO timestamp indicating when the confirmation period starts

renewalPolicy.confirmationPeriodEnd

Optional

string date-time

An ISO timestamp indicating when the confirmation period ends

paymentPolicy

Optional

object

The payment policy of the subscription plan

Optional Attributes

Collapse all

paymentPolicy.allowedPaymentGateways

Optional

array<string>

Allowed payment gateways

paymentPolicy.changePaymentMethodPolicy

Optional

string

Change payment method policy

alwaysneveronDraft

paymentPolicy.allowedChangePaymentMethodGateways

Optional

array<string>

Allowed change payment method gateways

requestedConsents

Optional

array

The subscription consent types requested during checkout

Optional Attributes

Collapse all

requestedConsents[].type

Optional

string

autorenewal

requestedConsents[].description

Optional

string

Was this section helpful?

Yes No

{
  "_id": "string",
  "name": "string",
  "pricingPolicy": "fixed",
  "variants": [],
  "billingCycle": {},
  "paymentSchedules": [
    {}
  ],
  "renewalPolicy": {
    "changesPeriodStart": "2030-01-23T23:00:00.123Z",
    "changesPeriodEnd": "2030-01-23T23:00:00.123Z",
    "allowedChanges": {},
    "confirmationPeriodStart": "2030-01-23T23:00:00.123Z",
    "confirmationPeriodEnd": "2030-01-23T23:00:00.123Z"
  },
  "paymentPolicy": {
    "allowedPaymentGateways": [],
    "changePaymentMethodPolicy": "always",
    "allowedChangePaymentMethodGateways": []
  },
  "requestedConsents": [
    {
      "type": "autorenewal",
      "description": "string"
    }
  ],
  "sellerId": "string"
}

Create a subscription Plan

Payload

name

Required

string

The name of the subscription plan

Optional Attributes

Collapse all

pricingPolicy

Optional

string

The pricing policy of the subscription plan

fixedinherited

variants

Optional

array

An array of variants of the subscription plan

variants[]._id

Required

string

The ID of the plan variant

variants[].name

Required

string

The name of the plan variant

Optional Attributes

Collapse all

variants[].canChangeVariant

Optional

boolean

Whether the variant is changeable or not

variants[].allowedVariants

Optional

array<string>

Allowed variants to change of the variant

paymentSchedules

Optional

array

An array of payment plans of the subscription plan

paymentSchedules[]._id

Required

string

Optional Attributes

Collapse all

paymentSchedules[].scheme

Optional

string

The scheme of the payment

one-offinstallments

paymentSchedules[].interval

Optional

string

The interval of the payment

DAYWEEKMONTH

paymentSchedules[].numberOfInstallments

Optional

number float

The number of installments of the payment

billingCycle

Optional

object

The billing plan of the subscription plan

billingCycle.scheme

Required

string

The scheme of the billing cycle

one-offrecurring

Optional Attributes

Collapse all

billingCycle.interval

Optional

string

The interval of the billing cycle

DAYWEEKMONTH

billingCycle.every

Optional

number float

The recurrence of the billing cycle

billingCycle.minimumIntervals

Optional

number float

renewalPolicy

Optional

object

The renewal policy of the subscription plan

Optional Attributes

Collapse all

renewalPolicy.changesPeriodStart

Optional

string date-time

An ISO timestamp indicating when the changes period starts

renewalPolicy.changesPeriodEnd

Optional

string date-time

An ISO timestamp indicating when the changes period ends

renewalPolicy.allowedChanges

Optional

object

Allowed Changes settings of the renewal policy

Optional Attributes

Collapse all

renewalPolicy.allowedChanges.ticketType

Optional

boolean

Whether changes of ticketTypes are allowed or not

renewalPolicy.allowedChanges.seat

Optional

boolean

Whether changes of seats are allowed or not

renewalPolicy.confirmationPeriodStart

Optional

string date-time

An ISO timestamp indicating when the confirmation period starts

renewalPolicy.confirmationPeriodEnd

Optional

string date-time

An ISO timestamp indicating when the confirmation period ends

paymentPolicy

Optional

object

The payment policy of the subscription plan

Optional Attributes

Collapse all

paymentPolicy.allowedPaymentGateways

Optional

array<string>

Allowed payment gateways

paymentPolicy.changePaymentMethodPolicy

Optional

string

Change payment method policy

alwaysneveronDraft

paymentPolicy.allowedChangePaymentMethodGateways

Optional

array<string>

Allowed change payment method gateways

requestedConsents

Optional

array

The subscription consent types requested during checkout

Optional Attributes

Collapse all

requestedConsents[].type

Optional

string

autorenewal

requestedConsents[].description

Optional

string

201

Created

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "name": "string",
  "pricingPolicy": "fixed",
  "variants": [],
  "paymentSchedules": [
    {}
  ],
  "billingCycle": {},
  "renewalPolicy": {
    "changesPeriodStart": "2030-01-23T23:00:00.123Z",
    "changesPeriodEnd": "2030-01-23T23:00:00.123Z",
    "allowedChanges": {},
    "confirmationPeriodStart": "2030-01-23T23:00:00.123Z",
    "confirmationPeriodEnd": "2030-01-23T23:00:00.123Z"
  },
  "paymentPolicy": {
    "allowedPaymentGateways": [],
    "changePaymentMethodPolicy": "always",
    "allowedChangePaymentMethodGateways": []
  },
  "requestedConsents": [
    {
      "type": "autorenewal",
      "description": "string"
    }
  ]
}

{
  "_id": "string",
  "name": "string",
  "pricingPolicy": "fixed",
  "variants": [],
  "billingCycle": {},
  "paymentSchedules": [
    {}
  ],
  "renewalPolicy": {
    "changesPeriodStart": "2030-01-23T23:00:00.123Z",
    "changesPeriodEnd": "2030-01-23T23:00:00.123Z",
    "allowedChanges": {},
    "confirmationPeriodStart": "2030-01-23T23:00:00.123Z",
    "confirmationPeriodEnd": "2030-01-23T23:00:00.123Z"
  },
  "paymentPolicy": {
    "allowedPaymentGateways": [],
    "changePaymentMethodPolicy": "always",
    "allowedChangePaymentMethodGateways": []
  },
  "requestedConsents": [
    {
      "type": "autorenewal",
      "description": "string"
    }
  ],
  "sellerId": "string"
}

Get a Subscription Plan

Query

No supported query parameters

200

400

Bad Request

401

Unauthorized

404

Not Found

Was this section helpful?

Yes No

{
  "_id": "string",
  "name": "string",
  "pricingPolicy": "fixed",
  "variants": [],
  "billingCycle": {},
  "paymentSchedules": [
    {}
  ],
  "renewalPolicy": {
    "changesPeriodStart": "2030-01-23T23:00:00.123Z",
    "changesPeriodEnd": "2030-01-23T23:00:00.123Z",
    "allowedChanges": {},
    "confirmationPeriodStart": "2030-01-23T23:00:00.123Z",
    "confirmationPeriodEnd": "2030-01-23T23:00:00.123Z"
  },
  "paymentPolicy": {
    "allowedPaymentGateways": [],
    "changePaymentMethodPolicy": "always",
    "allowedChangePaymentMethodGateways": []
  },
  "requestedConsents": [
    {
      "type": "autorenewal",
      "description": "string"
    }
  ],
  "sellerId": "string"
}

Update a subscription Plan

Payload

Optional Attributes

Collapse all

name

Optional

string

The name of the subscription plan

pricingPolicy

Optional

string

The pricing policy of the subscription plan

fixedinherited

variants

Optional

array

An array of variants of the subscription plan

variants[]._id

Required

string

The ID of the plan variant

variants[].name

Required

string

The name of the plan variant

Optional Attributes

Collapse all

variants[].canChangeVariant

Optional

boolean

Whether the variant is changeable or not

variants[].allowedVariants

Optional

array<string>

Allowed variants to change of the variant

paymentSchedules

Optional

array

An array of payment plans of the subscription plan

paymentSchedules[]._id

Required

string

Optional Attributes

Collapse all

paymentSchedules[].scheme

Optional

string

The scheme of the payment

one-offinstallments

paymentSchedules[].interval

Optional

string

The interval of the payment

DAYWEEKMONTH

paymentSchedules[].numberOfInstallments

Optional

number float

The number of installments of the payment

billingCycle

Optional

object

The billing plan of the subscription plan

billingCycle.scheme

Required

string

The scheme of the billing cycle

one-offrecurring

Optional Attributes

Collapse all

billingCycle.interval

Optional

string

The interval of the billing cycle

DAYWEEKMONTH

billingCycle.every

Optional

number float

The recurrence of the billing cycle

billingCycle.minimumIntervals

Optional

number float

renewalPolicy

Optional

object

The renewal policy of the subscription plan

Optional Attributes

Collapse all

renewalPolicy.changesPeriodStart

Optional

string date-time

An ISO timestamp indicating when the changes period starts

renewalPolicy.changesPeriodEnd

Optional

string date-time

An ISO timestamp indicating when the changes period ends

renewalPolicy.allowedChanges

Optional

object

Allowed Changes settings of the renewal policy

Optional Attributes

Collapse all

renewalPolicy.allowedChanges.ticketType

Optional

boolean

Whether changes of ticketTypes are allowed or not

renewalPolicy.allowedChanges.seat

Optional

boolean

Whether changes of seats are allowed or not

renewalPolicy.confirmationPeriodStart

Optional

string date-time

An ISO timestamp indicating when the confirmation period starts

renewalPolicy.confirmationPeriodEnd

Optional

string date-time

An ISO timestamp indicating when the confirmation period ends

paymentPolicy

Optional

object

The payment policy of the subscription plan

Optional Attributes

Collapse all

paymentPolicy.allowedPaymentGateways

Optional

array<string>

Allowed payment gateways

paymentPolicy.changePaymentMethodPolicy

Optional

string

Change payment method policy

alwaysneveronDraft

paymentPolicy.allowedChangePaymentMethodGateways

Optional

array<string>

Allowed change payment method gateways

requestedConsents

Optional

array

The subscription consent types requested during checkout

Optional Attributes

Collapse all

requestedConsents[].type

Optional

string

autorenewal

requestedConsents[].description

Optional

string

200

400

Bad Request

401

Unauthorized

404

Not Found

Was this section helpful?

Yes No

{
  "name": "string",
  "pricingPolicy": "fixed",
  "variants": [],
  "paymentSchedules": [
    {}
  ],
  "billingCycle": {},
  "renewalPolicy": {
    "changesPeriodStart": "2030-01-23T23:00:00.123Z",
    "changesPeriodEnd": "2030-01-23T23:00:00.123Z",
    "allowedChanges": {},
    "confirmationPeriodStart": "2030-01-23T23:00:00.123Z",
    "confirmationPeriodEnd": "2030-01-23T23:00:00.123Z"
  },
  "paymentPolicy": {
    "allowedPaymentGateways": [],
    "changePaymentMethodPolicy": "always",
    "allowedChangePaymentMethodGateways": []
  },
  "requestedConsents": [
    {
      "type": "autorenewal",
      "description": "string"
    }
  ]
}

{
  "_id": "string",
  "name": "string",
  "pricingPolicy": "fixed",
  "variants": [],
  "billingCycle": {},
  "paymentSchedules": [
    {}
  ],
  "renewalPolicy": {
    "changesPeriodStart": "2030-01-23T23:00:00.123Z",
    "changesPeriodEnd": "2030-01-23T23:00:00.123Z",
    "allowedChanges": {},
    "confirmationPeriodStart": "2030-01-23T23:00:00.123Z",
    "confirmationPeriodEnd": "2030-01-23T23:00:00.123Z"
  },
  "paymentPolicy": {
    "allowedPaymentGateways": [],
    "changePaymentMethodPolicy": "always",
    "allowedChangePaymentMethodGateways": []
  },
  "requestedConsents": [
    {
      "type": "autorenewal",
      "description": "string"
    }
  ],
  "sellerId": "string"
}

Get all Subscription Plans

Query

top

Optional

number float

A limit on the number of objects to be returned. Can range between 1 and 1000.

skip

Optional

number float

The number of objects to skip for the requested result

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "docs": [
    {
      "_id": "string",
      "name": "string",
      "pricingPolicy": "fixed",
      "variants": [],
      "billingCycle": {},
      "paymentSchedules": [
        {}
      ],
      "renewalPolicy": {
        "changesPeriodStart": "2030-01-23T23:00:00.123Z",
        "changesPeriodEnd": "2030-01-23T23:00:00.123Z",
        "allowedChanges": {},
        "confirmationPeriodStart": "2030-01-23T23:00:00.123Z",
        "confirmationPeriodEnd": "2030-01-23T23:00:00.123Z"
      },
      "paymentPolicy": {
        "allowedPaymentGateways": [],
        "changePaymentMethodPolicy": "always",
        "allowedChangePaymentMethodGateways": []
      },
      "requestedConsents": [
        {
          "type": "autorenewal",
          "description": "string"
        }
      ],
      "sellerId": "string"
    }
  ],
  "total": 1
}