Skip to content

Files

167 lines (98 loc) · 7.38 KB

api.md

File metadata and controls

167 lines (98 loc) · 7.38 KB

Payments

Types:

Methods:

  • client.payments.create({ ...params }) -> PaymentCreateResponse
  • client.payments.retrieve(paymentId) -> Payment
  • client.payments.list({ ...params }) -> PaymentListResponsesDefaultPageNumberPagination

Subscriptions

Types:

Methods:

  • client.subscriptions.create({ ...params }) -> SubscriptionCreateResponse
  • client.subscriptions.retrieve(subscriptionId) -> Subscription
  • client.subscriptions.update(subscriptionId, { ...params }) -> Subscription
  • client.subscriptions.list({ ...params }) -> SubscriptionsDefaultPageNumberPagination

Invoices

Payments

Methods:

  • client.invoices.payments.retrieve(paymentId) -> void

Licenses

Types:

Methods:

  • client.licenses.activate({ ...params }) -> LicenseKeyInstance
  • client.licenses.deactivate({ ...params }) -> void
  • client.licenses.validate({ ...params }) -> LicenseValidateResponse

LicenseKeys

Types:

Methods:

  • client.licenseKeys.retrieve(id) -> LicenseKey
  • client.licenseKeys.update(id, { ...params }) -> LicenseKey
  • client.licenseKeys.list({ ...params }) -> LicenseKeyListResponse

LicenseKeyInstances

Types:

Methods:

  • client.licenseKeyInstances.retrieve(id) -> LicenseKeyInstance
  • client.licenseKeyInstances.update(id, { ...params }) -> LicenseKeyInstance
  • client.licenseKeyInstances.list({ ...params }) -> LicenseKeyInstanceListResponse

Customers

Types:

Methods:

  • client.customers.create({ ...params }) -> Customer
  • client.customers.retrieve(customerId) -> Customer
  • client.customers.update(customerId, { ...params }) -> Customer
  • client.customers.list({ ...params }) -> CustomersDefaultPageNumberPagination

Refunds

Types:

Methods:

  • client.refunds.create({ ...params }) -> Refund
  • client.refunds.retrieve(refundId) -> Refund
  • client.refunds.list({ ...params }) -> RefundsDefaultPageNumberPagination

Disputes

Types:

Methods:

  • client.disputes.retrieve(disputeId) -> Dispute
  • client.disputes.list({ ...params }) -> DisputesDefaultPageNumberPagination

Payouts

Types:

Methods:

  • client.payouts.list({ ...params }) -> PayoutListResponsesDefaultPageNumberPagination

WebhookEvents

Types:

Methods:

  • client.webhookEvents.retrieve(webhookEventId) -> WebhookEvent
  • client.webhookEvents.list({ ...params }) -> WebhookEventsDefaultPageNumberPagination

Products

Types:

Methods:

  • client.products.create({ ...params }) -> Product
  • client.products.retrieve(id) -> Product
  • client.products.update(id, { ...params }) -> void
  • client.products.list({ ...params }) -> ProductListResponsesDefaultPageNumberPagination

Images

Types:

Methods:

  • client.products.images.update(id) -> ImageUpdateResponse

Misc

SupportedCountries

Types:

Methods:

  • client.misc.supportedCountries.list() -> SupportedCountryListResponse