Pause a Subscription

post

https://testapi.payarc.net/v1/subscriptions/{id}/pause

This API pause a subscription.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

id here refers to a specific subscription that needs to be paused.

Body Params

duration

int32

required

≥ 1

Pause duration value. Minimum is 1. Maximum allowed values are enforced server-side based on the selected unit: 365 for days, 52 for weeks, 12 for months, and 1 for years.

unit

string

enum

required

Pause duration unit. Allowed values are days, weeks, months, and years. Business rules may further restrict the allowed value based on the subscription plan interval.

Allowed:

Headers

string

required

Defaults to application/json

Indicates which content types, expressed as MIME types, the client is able to understand.

Content-Type

string

required

Defaults to application/json

Indicates the media type of the resource sent in the HTTP message body.

Possible Values:
application/json
application/x-www-form-urlencoded

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

404404

422422

500500