PerfexCRMInstall

Summary

Retrieve details of a specific subscription by its ID, optionally including related customer data and invoices.

Inputs

• Subscription ID (required) — The ID of the subscription to retrieve.
• Include Customer — Boolean flag to include the customer data associated with the subscription in the response.
• Include Invoices — Boolean flag to include invoices related to the subscription in the response.

Output shape

a single subscription record as JSON, optionally including nested customer and invoices data depending on options set.

The subscription is fetched by its ID; setting 'Include Customer' and/or 'Include Invoices' will include respective related data in the returned JSON object under keys 'customer' and 'invoices'. If errors occur, they may be returned in an error envelope if 'continueOnFail' is set.

Examples

Example 1: Get a subscription with its related customer data

Set Subscription ID to the target subscription's ID and enable 'Include Customer' option.

Example 2: Get a subscription including related invoices

Set Subscription ID and enable 'Include Invoices' option to include related invoices in the response.