SchemaRepeat PaymentsSubscriptions

Re-activate subscription

View as MarkdownOpen in Claude
Use this method to reactivate a subscription. To reactivate a subscription, you need its subscriptionId, which you sent in the request of the [Create Subscription](https://docs.payroc.com/api/schema/repeat-payments/subscriptions/create) method. **Note:** If you don't have the subscriptionId, use our [List Subscriptions](https://docs.payroc.com/api/schema/repeat-payments/subscriptions/list) method to search for the subscription. If your request is successful, our gateway restarts taking payments from the customer. To deactivate the subscription, use our [Deactivate Subscription](https://docs.payroc.com/api/schema/repeat-payments/subscriptions/deactivate) method.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

processingTerminalIdstringRequired4-50 characters
Unique identifier that we assigned to the terminal.
subscriptionIdstringRequired1-48 characters
Unique identifier that the merchant assigned to the subscription.

Response

Successful request. We re-activated the subscription.

subscriptionIdstring1-48 characters
Unique identifier that the merchant assigned to the subscription.
processingTerminalIdstring4-50 characters
Unique identifier of the terminal that the subscription is linked to.
paymentPlanobject
secureTokenobject
Object that contains information about the secure token.
namestring5-128 characters
Name of the subscription.
currencyenum

Currency of the transaction. The value for the currency follows the ISO 4217 standard.

currentStateobject
A snapshot of the subscription's current state.
startDatedate

Format: YYYY-MM-DD
Subscription’s start date.

typeenum

How the merchant takes the payment from the customer’s account.

  • manual – The merchant manually collects payments from the customer.
  • automatic – The terminal automatically collects payments from the customer.
Allowed values:
frequencyenum
Indicates how often the merchant or the terminal collects a payment from the customer.
Allowed values:
descriptionstring1-128 characters
Description of the subscription.
setupOrderobject
recurringOrderobject
Object that contains information about the cost of each payment.
endDatedate

Format: YYYY-MM-DD Subscription’s end date.
Note: If you provide values for both length and endDate, our gateway uses the value for endDate to determine when the subscription should end.

lengthinteger>=0

Total number of billing cycles. To indicate that the subscription should run indefinitely, send a value of 0. This value replaces the length inherited from the payment plan.
Note: If you provide values for both length and endDate, our gateway uses the value for endDate to determine when the subscription should end.

pauseCollectionForinteger>=0
Number of billing cycles that the merchant wants to pause payments for. For example, if the merchant wants to offer a free trial period.
customFieldslist of objects
Array of customField objects.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
406
Not Acceptable Error
409
Conflict Error
415
Unsupported Media Type Error
500
Internal Server Error