• Subcategories:
• Contract Attachments
• Credit Cards
• Descriptive Flexfields
• Parties
• Products
• Sales Credits
• Subscription Contacts
• Subscription Teams
• Subscription User Actions
• Supporting Document Attachments
• Validate Subscriptions

Subscriptions REST Endpoints

Sort by

Task Path Method

Subscriptions

The subscriptions resource is used to view, create, update, and delete subscriptions. A subscription includes information such as start and end dates, customer, subscription profile, and total contract value.

Activate a subscription

Method: post

Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/activate

Calculate credit amount

Method: post

Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/calculateCreditAmount

Calculate early termination fee

Method: post

Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/calculateEarlyTerminationFee

Cancel a subscription

Method: post

Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/cancel

Close a subscription

Method: post

Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/close

Create a subscription

Method: post

Path: /crmRestApi/resources/11.13.18.05/subscriptions

Delete a subscription

Method: delete

Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}

Duplicate a subscription

Method: post

Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/duplicateSubscription

Get a subscription

Method: get

Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}

Get all subscriptions

Method: get

Path: /crmRestApi/resources/11.13.18.05/subscriptions

Get event template output

Method: post

Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/getEventTemplateOutput

Hold a subscription

Method: post

Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/putOnHold

Move all subscription products

Method: post

Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/moveProducts

Preview a subscription

Method: post

Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/previewSubscriptions

Raise user transition

Method: post

Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/raiseUserTransition

Remove hold on a subscription

Method: post

Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/removeHold

Renew a subscription

Method: post

Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/renew

Submit a scheduled process

Method: post

Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/submitEssJobRequest

Submit a subscription for validation

Method: post

Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/submitValidation

Unlock subscription

Method: post

Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/action/unlockSubscription

Update a subscription

Method: patch

Path: /crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}