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",
    "status": "PAYMENT_PENDING",
    "pricingType": "FREE",
    "paymentCollection": "NOT_REQUIRED",
    "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",
    "cancelReason": "UPGRADE_OR_DOWNGRADE",
    "metadata": {},
    "currentBillingPeriodStart": "2023-11-07T05:31:56Z",
    "currentBillingPeriodEnd": "2023-11-07T05:31:56Z",
    "paymentCollectionMethod": "CHARGE",
    "prices": []
  }
}

Authorizations

​
X-API-KEY
string
header
required

Server API Key

Headers

​
X-API-KEY
string
required

API 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

OK

Response object

​
data
Subscription · object
required

Customer subscription to a plan