Subscriptions

Pause Subscription Collection

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

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/pauseCollection Request body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

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

Cancel Subscription PATCH

Cancel a Subscription with specified options for timing and refunds.

End Subscription Trial PATCH

End a Subscription's trial immediately and start the paid subscription. The Subscription must be in trialing status. The first Invoice is created and charged right away using the payment method on file. The outcome (emails, webhooks, orders) is identical to the trial ending naturally.