Skip to main content
POST
/
api
/
v1
/
subscriptions
/
{id}
/
delegate
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.delegate('x', {
  targetCustomerId: 'targetCustomerId',
});

console.log(subscription.data);
{
  "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

Delegate the payment responsibility for a subscription to a different customer. The subscription remains associated with the original customer, but billing and payment obligations are transferred to the target customer. This is useful for B2B scenarios where one entity consumes the service while another handles payment.

​
targetCustomerId
string
required

The unique identifier of the customer who will assume payment responsibility for this subscription. This customer must already exist in your Stigg account and have a valid payment method if the subscription requires payment.

Maximum string length: 255

Response

The updated subscription object.

Response object

​
data
Subscription · object
required

Customer subscription to a plan