plans

Subscribe customer to plan

Creates a new order for a customer subscribing to a plan. The order will be created with the plan's products and pricing attributes.

post/plans/{planId}/subscribe

Request

  • Base URL: https://api.agentpaid.io/api/v1
  • URL: https://api.agentpaid.io/api/v1/plans/{planId}/subscribe
  • Auth: HTTP bearer

Path parameters

planIdstring uuid required

The ID of the plan

Query parameters

customerExternalIdstring required

The external ID of the customer

currencystring required

The currency code for the order (e.g., "USD", "EUR")

Response

Customer subscribed to plan successfully

idstring
namestring
descriptionstring
customerIdstring
organizationIdstring
startDatestring
endDatestring
totalAmountnumber double
estimatedTaxnumber double
billedAmountNoTaxnumber double
billedTaxnumber double
totalBilledAmountnumber double
pendingBillingAmountnumber double
creationState'active' | 'draft'

Changes

No recorded changes to this operation across all 1 revision of this API.