Recurrency

📄️ /recurrency/plans

This endpoint is used to create new subscription plans. Subscription plans define the terms, prices and benefits associated with different levels of service offered to customers. When creating a new plan, pertinent details such as the plan name, description, price, duration, and any other relevant attributes must be provided in the body of the request. Upon successful creation, the system returns the complete details of the newly created plan, including a unique identifier for future reference.

📄️ /recurrency/plans

This endpoint is used to retrieve all available subscription plans. Upon accessing this endpoint, the system returns a list of all available subscription plans along with their details such as name, description, price, duration and included features.

📄️ /recurrency/plans/{planId}

This endpoint is used to update the details of an existing subscription plan based on the provided ID. Subscription plans may need to be updated to reflect changes in terms, pricing, benefits or other attributes associated with the plan. When submitting an upgrade request to this endpoint, pertinent plan details such as name, description, price, duration, and features must be provided in the body of the request. The ID of the plan to be updated must be specified in the URL. After successful update, the system returns the updated plan details.

📄️ /recurrency/plans/{planId}

This endpoint is used to delete an existing subscription plan based on the ID provided.

📄️ /recurrency/subscriptions

Endpoint responsible for creating a new subscription

📄️ /recurrency/subscriptions/{subscriptionId}

This endpoint is used to retrieve the details of a specific subscription based on the provided ID. Upon accessing this endpoint, the system returns the full subscription details, including the associated plan, customer, status, start date, end date, and any other relevant details.

📄️ /recurrency/subscriptions/{subscriptionId}/cancel

This endpoint is used to cancel a specific subscription based on the ID provided. When sending a cancellation request to this endpoint, the system cancels the specified subscription. If the subscription is successfully canceled, the system returns a response with an empty body.