Skip to main content
POST
/
subscriptions
/
{subscriptionId}
curl --request POST \
     --url https://api.tryaqueduct.com/v1/subscriptions/subscriptionId \
     --header 'Accept: application/json' \
     --header 'Authorization: null' \
     --header 'Content-Type: application/json'

{
  "id": "sub_01FSSVRVGQ7GGB13815DE3F518",
  "name": "Monthly gold plan",
  "accountOwnerId": "<string>",
  "createdAt": "2022-01-15T15:53:00.000Z",
  "endDate": "2023-01-15T15:53:00.000Z",
  "productId": "prod_12PSSMRLGQ7MMQ13565DE3F557",
  "billingFrequency": "monthly",
  "firstBillingDate": "2022-03-15T15:53:00.000Z",
  "priceModelId": "<string>",
  "status": "<string>"
}
curl --request POST \
     --url https://api.tryaqueduct.com/v1/subscriptions/subscriptionId \
     --header 'Accept: application/json' \
     --header 'Authorization: null' \
     --header 'Content-Type: application/json'

Authorizations

​
Authorization
string
header
required

Path Parameters

​
subscriptionId
string
required

The id of the subscription to retrieve

Body

application/json
​
name
string

The subscription's name. Meant to be displayable to your customers.

Example:

"Monthly gold plan"

​
variables
object

An object containing the inputs the PriceModel expects.

​
startDate
string<date>

Time at which the subscription started or is scheduled to start. Can also be used for backdating

Example:

"2022-04-02T00:00:00.000Z"

​
endDate
string<date>

Time at which the subscription ended or is scheduled to end.

Example:

"2023-01-15T15:53:00.000Z"

Response

200 - application/json

Returns the Subscription that was updated in the request

A way to bill customers on a recurring basis. Subscriptions are created from a price model with a billing frequency.

​
id
string

A unique identifier for the object

Example:

"sub_01FSSVRVGQ7GGB13815DE3F518"

​
name
string

The subscription's name. Meant to be displayable to your customers.

Example:

"Monthly gold plan"

​
accountOwnerId
string

Id of the account owner associated with this subscription

​
createdAt
string<date>

Time at which the object was created.

Example:

"2022-01-15T15:53:00.000Z"

​
endDate
string<date>

Time at which the subscription ended or is scheduled to end.

Example:

"2023-01-15T15:53:00.000Z"

​
productId
string

Id of the product this subscription provides access to

Example:

"prod_12PSSMRLGQ7MMQ13565DE3F557"

​
billingFrequency
string

The frequency at which this subscription is billed. Values include once, monthly, annually

Example:

"monthly"

​
firstBillingDate
string<date>

The date of the first full invoice and anchors subsequent invoices on the the day of the month.

For example, a $30 dollar monthly recurring bill that is sent in the middle of April with an billing cycle anchor of May 1st would result in an invoice created immediately for $15 and then another $30 invoice sent out on May 1st.

Example:

"2022-03-15T15:53:00.000Z"

​
priceModelId
string

Id of the price model associated with this subscription

​
status
string

The status of this subscription. Values include ended, and active.