api.md

Invoices

Types:

• InvoiceCreateResponse
• InvoiceRetrieveResponse
• InvoiceListResponse

Methods:

• client.invoices.create({ ...params }) -> InvoiceCreateResponse
• client.invoices.retrieve(id) -> InvoiceRetrieveResponse
• client.invoices.list({ ...params }) -> InvoiceListResponse

InvoiceLineItems

Types:

• InvoiceLineItemRetrieveResponse
• InvoiceLineItemListResponse

Methods:

• client.invoiceLineItems.retrieve(id) -> InvoiceLineItemRetrieveResponse
• client.invoiceLineItems.list({ ...params }) -> InvoiceLineItemListResponse

Catalogs

Types:

• CatalogCreateResponse
• CatalogRetrieveResponse
• CatalogUpdateResponse
• CatalogListResponse
• CatalogCloneResponse
• CatalogRetrieveDefaultResponse

Methods:

• client.catalogs.create({ ...params }) -> CatalogCreateResponse
• client.catalogs.retrieve(id) -> CatalogRetrieveResponse
• client.catalogs.update(id, { ...params }) -> CatalogUpdateResponse
• client.catalogs.list({ ...params }) -> CatalogListResponse
• client.catalogs.clone(id, { ...params }) -> CatalogCloneResponse
• client.catalogs.retrieveDefault() -> CatalogRetrieveDefaultResponse

CheckoutSessions

Types:

• CheckoutSessionCreateResponse
• CheckoutSessionRetrieveResponse
• CheckoutSessionListResponse

Methods:

• client.checkoutSessions.create({ ...params }) -> CheckoutSessionCreateResponse
• client.checkoutSessions.retrieve(id) -> CheckoutSessionRetrieveResponse
• client.checkoutSessions.list({ ...params }) -> CheckoutSessionListResponse

Products

Types:

• ProductCreateResponse
• ProductRetrieveResponse
• ProductUpdateResponse
• ProductListResponse

Methods:

• client.products.create({ ...params }) -> ProductCreateResponse
• client.products.retrieve(id) -> ProductRetrieveResponse
• client.products.update(id, { ...params }) -> ProductUpdateResponse
• client.products.list({ ...params }) -> ProductListResponse

Prices

Types:

• PriceCreateResponse
• PriceUpdateResponse
• PriceListResponse

Methods:

• client.prices.create({ ...params }) -> PriceCreateResponse
• client.prices.update(id, { ...params }) -> PriceUpdateResponse
• client.prices.list({ ...params }) -> PriceListResponse

Discounts

Types:

• DiscountCreateResponse
• DiscountRetrieveResponse
• DiscountUpdateResponse
• DiscountListResponse

Methods:

• client.discounts.create({ ...params }) -> DiscountCreateResponse
• client.discounts.retrieve(id) -> DiscountRetrieveResponse
• client.discounts.update(id, { ...params }) -> DiscountUpdateResponse
• client.discounts.list({ ...params }) -> DiscountListResponse

Customers

Types:

• CustomerCreateResponse
• CustomerRetrieveResponse
• CustomerUpdateResponse
• CustomerListResponse
• CustomerRetrieveBillingResponse

Methods:

• client.customers.create({ ...params }) -> CustomerCreateResponse
• client.customers.retrieve(externalID) -> CustomerRetrieveResponse
• client.customers.update(externalID, { ...params }) -> CustomerUpdateResponse
• client.customers.list({ ...params }) -> CustomerListResponse
• client.customers.retrieveBilling(externalID) -> CustomerRetrieveBillingResponse

Payments

Types:

• PaymentRetrieveResponse
• PaymentListResponse
• PaymentRefundResponse

Methods:

• client.payments.retrieve(id) -> PaymentRetrieveResponse
• client.payments.list({ ...params }) -> PaymentListResponse
• client.payments.refund(id, { ...params }) -> PaymentRefundResponse

PaymentMethods

Types:

• PaymentMethodRetrieveResponse
• PaymentMethodListResponse

Methods:

• client.paymentMethods.retrieve(id) -> PaymentMethodRetrieveResponse
• client.paymentMethods.list({ ...params }) -> PaymentMethodListResponse

Subscriptions

Types:

• SubscriptionCreateResponse
• SubscriptionRetrieveResponse
• SubscriptionListResponse
• SubscriptionAdjustResponse
• SubscriptionCancelResponse

Methods:

• client.subscriptions.create({ ...params }) -> SubscriptionCreateResponse
• client.subscriptions.retrieve(id) -> SubscriptionRetrieveResponse
• client.subscriptions.list({ ...params }) -> SubscriptionListResponse
• client.subscriptions.adjust(id, { ...params }) -> SubscriptionAdjustResponse
• client.subscriptions.cancel(id, { ...params }) -> SubscriptionCancelResponse

UsageEvents

Types:

• UsageEventCreateResponse
• UsageEventRetrieveResponse

Methods:

• client.usageEvents.create({ ...params }) -> UsageEventCreateResponse
• client.usageEvents.retrieve(id) -> UsageEventRetrieveResponse

UsageMeters

Types:

• UsageMeterCreateResponse
• UsageMeterRetrieveResponse
• UsageMeterUpdateResponse
• UsageMeterListResponse

Methods:

• client.usageMeters.create({ ...params }) -> UsageMeterCreateResponse
• client.usageMeters.retrieve(id) -> UsageMeterRetrieveResponse
• client.usageMeters.update(id, { ...params }) -> UsageMeterUpdateResponse
• client.usageMeters.list({ ...params }) -> UsageMeterListResponse