Subscriptions

Cancel Subscription

Cancel a Subscription with specified options for timing and refunds.

Authorization

Public key Secret key
x-fngs-public-key<token>

In: header

x-fngs-secret-key<token>

In: header

Path Parameters

subscriptionIdOrNumber*string

Subscription ID or order number

Match^#?([0-9A-Za-z]{12,32}|[0-9]+)(-[0-9]+)?$

Request Body

application/json

PATCH /v0/subscriptions/:subscriptionIdOrNumber/cancel Request body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

PATCH
/v0/subscriptions/{subscriptionIdOrNumber}/cancel
curl -X PATCH "https://example.com/v0/subscriptions/string/cancel" \  -H "Content-Type: application/json" \  -d '{}'
{  "status": "success",  "data": {    "success": true  }}

Charge Subscription POST

Charge an additional one-off amount to an active Subscription. Creates a new Invoice and handles payment processing. Multiple items (up to 20) can be charged in a single call; each becomes its own Invoice line. All items must share the same currency, and that currency must match the Subscription's currency. Tax is calculated on the total and distributed proportionally across the lines.

Pause Subscription Collection PATCH

Pause a Subscription's payment collection temporarily with options for handling payments. During the pause period: - No charges will be made - Access to subscription benefits will be maintained - Can be resumed manually or automatically at a specified time