PayOrc
Subscription Plan

Activate Subscription Plan

Activate a previously deactivated subscription plan to allow new customer subscriptions.

Activate Subscription Plan

Version: 3.0.0

Generate an API Key for the Subscription channel before making requests.

Use this endpoint to activate a previously deactivated subscription plan. Once activated, the plan can be assigned to new customers for subscriptions.

Endpoint

MethodURL
POSThttps://api.payorc.com/subscriptions/v1/activate

Please use the test credentials for sandbox testing.

Authentication

Include the following headers in every request:

HeaderTypeDescription
merchant-keyStringYour merchant key
merchant-secretStringYour merchant secret

All API requests must be made over HTTPS. Requests made over plain HTTP will be rejected.

Request Body

FieldTypeRequiredDescription
data_idStringYesEncrypted plan identifier from Plan List or create-plan response. The plan must currently be Deactivated and not expired.

Obtain data_id from the Plan List endpoint (data[].data_id). Do not use the plain plan_id display value here.

Response (200 OK)

FieldTypeDescription
messageStringHuman-readable status message
statusStringsuccess or error
codeStringStatus code (00 for success)

Code Examples

curl -X POST https://api.payorc.com/subscriptions/v1/activate \
  -H "Content-Type: application/json" \
  -H "merchant-key: YOUR_MERCHANT_KEY" \
  -H "merchant-secret: YOUR_MERCHANT_SECRET" \
  -d '{
    "data_id": "ak80VjZGeURhT2hSM"
}'

Example Response

{
    "message": "Subscription plan activated successfully.",
    "status": "success",
    "code": "00"
}

Activating a plan makes it available for new customer subscriptions. Existing subscriptions on the plan are unaffected by activation or deactivation.

On this page