Skip to main content

Built-in API reference 📚

Customers

customer.create(input: CreateCustomerInput) => Promise<Customer>;
customer.update(id: string, input: UpdateCustomerInput) => Promise<Customer>;
customer.get(id: string) => Promise<Customer>;
customer.list(input?: Partial<ListCustomersQueryVariables>) => Promise<CustomerList>;
customer.createSession(input?: CreateCustomerSessionInput) => Promise<CustomerSession>;
customer.updateSession(id: string, input: UpdateCustomerSessionInput) => Promise<CustomerSession>;

Invoices

invoice.create(input: CreateInvoiceInput) => Promise<Invoice>;
invoice.get(id: string) => Promise<Invoice>;
invoice.list(input?: Partial<ListInvoicesQueryVariables>) => Promise<InvoiceList>;

Licenses

license.create(input: CreateLicenseInput) => Promise<License>;
license.update(id: string, input: UpdateLicenseInput) => Promise<License>;
license.activate(id: string, input: ActivateLicenseInput) => Promise<License>;
license.get(id: string) => Promise<License>;
license.list(input?: Partial<ListLicensesQueryVariables>) => Promise<LicenseList>;

License users

licenseUser.create(input: CreateLicenseUserInput) => Promise<LicenseUser>;
licenseUser.update(id: string, input: UpdateLicenseUserInput) => Promise<LicenseUser>;
licenseUser.get(id: string) => Promise<LicenseUser>;
licenseUser.remove(id: string) => Promise<LicenseUser>;
licenseUser.list(input?: Partial<ListLicenseUsersQueryVariables>) => Promise<LicenseUserList>;

Product

product.create(input: CreateProductInput) => Promise<Product>;
product.update(id: string, input: UpdateProductInput) => Promise<Product>;
product.get(id: string) => Promise<Product>;
product.list(input?: Partial<ListProductsQueryVariables>) => Promise<ProductList>;

Subscription

subscription.create(input: CreateSubscriptionInput) => Promise<Subscription>;
subscription.update(id: string, input: UpdateSubscriptionInput) => Promise<Subscription>;
subscription.get(id: string) => Promise<Subscription>;
subscription.list(input?: Partial<ListSubscriptionsQueryVariables>) => Promise<SubscriptionList>;
subscription.upgrade(id: string, input: UpgradeSubscriptionInput) => Promise<Subscription>;
subscription.downgrade(id: string, input: DowngradeSubscriptionInput) => Promise<Subscription>;
subscription.cancel(id: string, input: CancelSubscriptionInput) => Promise<Subscription>;

Transaction

transaction.create(input: CreateTransactionInput) => Promise<Transaction>;
transaction.get(id: string) => Promise<Transaction>;
transaction.list(input?: Partial<ListTransactionsQueryVariables>) => Promise<TransactionList>;