Update a subscription

Updates an active subscription’s properties including billing period, add-ons, unit quantities, and discounts.

PATCH /api/v1/subscriptions/{id}

JavaScript

JavaScript

import Stigg from '@stigg/typescript';

const client = new Stigg({
  apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});

const subscription = await client.v1.subscriptions.update('x');

console.log(subscription.data);

200

{
  "data": {
    "id": "<string>",
    "customerId": "<string>",
    "billingId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "startDate": "2023-11-07T05:31:56Z",
    "planId": "<string>",
    "payingCustomerId": "<string>",
    "resourceId": "<string>",
    "endDate": "2023-11-07T05:31:56Z",
    "effectiveEndDate": "2023-11-07T05:31:56Z",
    "cancellationDate": "2023-11-07T05:31:56Z",
    "trialEndDate": "2023-11-07T05:31:56Z",
    "metadata": {},
    "currentBillingPeriodStart": "2023-11-07T05:31:56Z",
    "currentBillingPeriodEnd": "2023-11-07T05:31:56Z",
    "billingCycleAnchor": "2023-11-07T05:31:56Z",
    "prices": [],
    "addons": [],
    "coupons": [],
    "futureUpdates": [],
    "budget": {
      "limit": 123,
      "hasSoftLimit": true
    },
    "minimumSpend": {
      "amount": 123
    },
    "subscriptionEntitlements": [],
    "latestInvoice": {
      "billingId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "requiresAction": true,
      "total": 123,
      "amountDue": 123,
      "currency": "<string>",
      "pdfUrl": "<string>"
    },
    "trial": {}
  }
}

Authorizations

X-API-KEY · string · header · required

Server API Key

Headers

X-ACCOUNT-ID · string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-ID · string

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Path Parameters

id · string · required

The unique identifier of the entity

Required string length: 1 - 255

Body

application/json

Partially update an existing subscriptoin. Only provided fields are updated.

metadata · object

Additional metadata for the subscription

Show child attributes

charges · object[]

Show child attributes

addons · SubscriptionAddon · object[]

Show child attributes

trialEndDate · string<date-time>

Subscription trial end date

promotionCode · string

Promotion code

Maximum string length: 255

entitlements · (SubscriptionFeatureEntitlementRequest · object | SubscriptionCreditEntitlementRequest · object)[]

Feature entitlement configuration for a subscription

SubscriptionFeatureEntitlementRequest

SubscriptionCreditEntitlementRequest

Show child attributes

billingPeriod · enum<string>

Available options: MONTHLY, ANNUALLY

awaitPaymentConfirmation · boolean

Await payment confirmation

billingInformation · object

Show child attributes

scheduleStrategy · enum<string>

Available options: END_OF_BILLING_PERIOD, END_OF_BILLING_MONTH, IMMEDIATE

budget · object

Show child attributes

minimumSpend · object

Minimum spend amount

Show child attributes

priceOverrides · object[]

Show child attributes

appliedCoupon · object

Show child attributes

billingCycleAnchor · enum<string>

Available options: UNCHANGED, NOW

cancellationDate · string<date-time> | null

Subscription cancellation date

Response

200

application/json

The updated subscription object.

Response object

data · Subscription · object · required

Customer subscription to a plan

Show child attributes