Skip to main content
POST
/
subscriptions
/
{subscriptionId}
/
topups
{
  "topup": {
    "productOfferingId": "<string>",
    "productOffering": {
      "productOfferingId": "<string>",
      "name": "<string>",
      "price": {
        "grossPrice": 10,
        "discount": 5,
        "netPrice": 5,
        "currency": "USD",
        "priceType": "ONE_TIME",
        "boundMonths": 12,
        "billingCycle": {
          "period": "MONTHLY",
          "interval": 1
        },
        "taxIncluded": true
      },
      "productOfferingGroupId": "<string>",
      "group": {
        "productOfferingGroupId": "<string>",
        "name": "<string>",
        "category": "SUBSCRIPTION_CELL"
      }
    },
    "appliedAt": "2023-11-07T05:31:56Z",
    "metadata": {}
  }
}

Authorizations

​
X-API-Key
string
header
required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Headers

​
X-Idempotency-Key
string

A unique key to ensure idempotency of requests. If a request with the same key has already been processed, the same result will be returned. The key must be unique for each distinct operation. Keys are expired after 24 hours, but we recommend using a new key for each request.

Modified requests with the same idempotency keys are rejected with a 409 Conflict status code.

Maximum length: 256

Path Parameters

​
subscriptionId
string
required

The unique identifier of the subscription.

Body

application/json

The top-up to add to the subscription.

Request to add a top-up to a subscription.

​
productOfferingId
string
required

The unique identifier of the top-up product offering to apply.

​
metadata
object

A set of key-value pairs that can be attached to an object for storing additional information in a semi-structured format.

Response

Top-up applied successfully.

​
topup
object
required

Details about the applied top-up.

⌘I