Jump to Content
API Reference
Log In
API Reference
Log In
API Reference
Retrieve a subscription
Search
JUMP TO
Guides
Developer quickstart
How Aqueduct works
Price functions types
Common business models
Using the API
Authentication
Auto provisioning with webhooks
Types of webhook events
Idempotency
API Reference
Invoice
Create a new invoice
post
Retrieve a list of invoices
get
Add a new line item
post
Send an Invoice via email
post
Refund an Invoice
post
Void an Invoice
post
Retrieve an Invoice
get
AccountOwner
Create a new account owner
post
Retrieve a list of account owners
get
Retrieve an AccountOwner
get
Update an AccountOwner
post
Generate a Customer Portal link.
post
InvoiceLineItem
Update an InvoiceLineItem
post
Delete an InvoiceLineItem
delete
Bill
Bill against price models, and automatically create an invoice and subscription as needed
post
Send events you may want to bill against Aqueduct
post
Retrieve billable events that have been sent to Aqueduct
get
Delete one or more BillableEvents
delete
Products
Create a new product
post
Retrieve a product
get
ProductPurchases
Get all product purchases in an optional time range based on the service period start or billing end dates associated with the product purchase
get
PriceModel
Create a new price model
post
List all price models
get
Retrieve a PriceModel
get
Preview the output of a PriceModel
post
Subscriptions
Retrieve a list of subscriptions
get
Retrieve a subscription
get
Update a subscription
post
Delete a Subscription
delete
Webhooks
Creates a webhook endpoint.
post
List all webhook endpoints
get
Provisioning
Retrieve a Provisioning object
get
Powered by
Retrieve a subscription
get
https://api.tryaqueduct.com/v1/subscriptions/
{subscriptionId}
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
Header
RESPONSE
Click
Try It!
to start a request and see the response here!
