# CheckoutSessions Types: - CheckoutSessionBillingAddress - CheckoutSessionCustomization - CheckoutSessionFlags - CheckoutSessionRequest - CheckoutSessionResponse - CheckoutSessionStatus - CustomField - ProductItemReq - SubscriptionData - ThemeConfig - ThemeModeConfig - CheckoutSessionPreviewResponse Methods: - client.checkoutSessions.create({ ...params }) -> CheckoutSessionResponse - client.checkoutSessions.retrieve(id) -> CheckoutSessionStatus - client.checkoutSessions.preview({ ...params }) -> CheckoutSessionPreviewResponse # Payments Types: - AttachExistingCustomer - BillingAddress - CreateNewCustomer - CustomFieldResponse - CustomerLimitedDetails - CustomerRequest - IntentStatus - NewCustomer - OneTimeProductCartItem - Payment - PaymentMethodTypes - PaymentRefundStatus - RefundListItem - PaymentCreateResponse - PaymentListResponse - PaymentRetrieveLineItemsResponse Methods: - client.payments.list({ ...params }) -> PaymentListResponsesDefaultPageNumberPagination - client.payments.create({ ...params }) -> PaymentCreateResponse - client.payments.retrieve(paymentID) -> Payment - client.payments.retrieveLineItems(paymentID) -> PaymentRetrieveLineItemsResponse # Subscriptions Types: - AddonCartResponseItem - AttachAddon - CancellationFeedback - CreditEntitlementCartResponse - MeterCartResponseItem - MeterCreditEntitlementCartResponse - OnDemandSubscription - ScheduledPlanChange - Subscription - SubscriptionStatus - TimeInterval - UpdateSubscriptionPlanReq - SubscriptionCreateResponse - SubscriptionListResponse - SubscriptionChargeResponse - SubscriptionPreviewChangePlanResponse - SubscriptionRetrieveCreditUsageResponse - SubscriptionRetrieveUsageHistoryResponse - SubscriptionUpdatePaymentMethodResponse Methods: - client.subscriptions.list({ ...params }) -> SubscriptionListResponsesDefaultPageNumberPagination - client.subscriptions.create({ ...params }) -> SubscriptionCreateResponse - client.subscriptions.retrieve(subscriptionID) -> Subscription - client.subscriptions.update(subscriptionID, { ...params }) -> Subscription - client.subscriptions.charge(subscriptionID, { ...params }) -> SubscriptionChargeResponse - client.subscriptions.changePlan(subscriptionID, { ...params }) -> void -

client.subscriptions.retrieveUsageHistory(subscriptionID, { ...params }) -> SubscriptionRetrieveUsageHistoryResponsesDefaultPageNumberPagination

- client.subscriptions.updatePaymentMethod(subscriptionID, { ...params }) -> SubscriptionUpdatePaymentMethodResponse - client.subscriptions.previewChangePlan(subscriptionID, { ...params }) -> SubscriptionPreviewChangePlanResponse - client.subscriptions.retrieveCreditUsage(subscriptionID) -> SubscriptionRetrieveCreditUsageResponse - client.subscriptions.cancelChangePlan(subscriptionID) -> void # Invoices ## Payments Methods: - client.invoices.payments.retrieve(paymentID) -> Response - client.invoices.payments.retrieveRefund(refundID) -> Response - client.invoices.payments.retrievePayout(payoutID) -> Response # Licenses Types: - LicenseActivateResponse - LicenseValidateResponse Methods: - client.licenses.activate({ ...params }) -> LicenseActivateResponse - client.licenses.deactivate({ ...params }) -> void - client.licenses.validate({ ...params }) -> LicenseValidateResponse # LicenseKeys Types: - LicenseKey - LicenseKeyStatus Methods: - client.licenseKeys.list({ ...params }) -> LicenseKeysDefaultPageNumberPagination - client.licenseKeys.retrieve(id) -> LicenseKey - client.licenseKeys.update(id, { ...params }) -> LicenseKey - client.licenseKeys.create({ ...params }) -> LicenseKey # LicenseKeyInstances Types: - LicenseKeyInstance Methods: - client.licenseKeyInstances.list({ ...params }) -> LicenseKeyInstancesDefaultPageNumberPagination - client.licenseKeyInstances.retrieve(id) -> LicenseKeyInstance - client.licenseKeyInstances.update(id, { ...params }) -> LicenseKeyInstance # Customers Types: - Customer - CustomerPortalSession - CustomerListCreditEntitlementsResponse - CustomerListEntitlementsResponse - CustomerRetrievePaymentMethodsResponse Methods: - client.customers.list({ ...params }) -> CustomersDefaultPageNumberPagination - client.customers.retrieve(customerID) -> Customer - client.customers.create({ ...params }) -> Customer - client.customers.update(customerID, { ...params }) -> Customer - client.customers.retrievePaymentMethods(customerID) -> CustomerRetrievePaymentMethodsResponse - client.customers.listCreditEntitlements(customerID) -> CustomerListCreditEntitlementsResponse - client.customers.deletePaymentMethod(paymentMethodID, { ...params }) -> void - client.customers.listEntitlements(customerID) -> CustomerListEntitlementsResponse - client.customers.listEntitlementGrants(customerID, { ...params }) -> EntitlementGrantsDefaultPageNumberPagination ## CustomerPortal Methods: - client.customers.customerPortal.create(customerID, { ...params }) -> CustomerPortalSession ## Wallets Types: - CustomerWallet - WalletListResponse Methods: - client.customers.wallets.list(customerID) -> WalletListResponse ### LedgerEntries Types: - CustomerWalletTransaction Methods: -

client.customers.wallets.ledgerEntries.list(customerID, { ...params }) -> CustomerWalletTransactionsDefaultPageNumberPagination

- client.customers.wallets.ledgerEntries.create(customerID, { ...params }) -> CustomerWallet # Refunds Types: - Refund - RefundStatus Methods: - client.refunds.list({ ...params }) -> RefundListItemsDefaultPageNumberPagination - client.refunds.create({ ...params }) -> Refund - client.refunds.retrieve(refundID) -> Refund # Disputes Types: - Dispute - DisputeStage - DisputeStatus - GetDispute - DisputeListResponse Methods: - client.disputes.list({ ...params }) -> DisputeListResponsesDefaultPageNumberPagination - client.disputes.retrieve(disputeID) -> GetDispute # Payouts Types: - PayoutListResponse Methods: - client.payouts.list({ ...params }) -> PayoutListResponsesDefaultPageNumberPagination ## Breakup Types: - BreakupRetrieveResponse Methods: - client.payouts.breakup.retrieve(payoutID) -> BreakupRetrieveResponse ### Details Types: - DetailListResponse Methods: - client.payouts.breakup.details.list(payoutID, { ...params }) -> DetailListResponsesDefaultPageNumberPagination - client.payouts.breakup.details.downloadCsv(payoutID) -> void # Products Types: - AddMeterToPrice - AttachCreditEntitlement - AttachProductEntitlement - CbbProrationBehavior - CreditEntitlementMappingResponse - DigitalProductDelivery - DigitalProductDeliveryFile - LicenseKeyDuration - Price - Product - ProductEntitlementSummary - ProductListResponse - ProductUpdateFilesResponse Methods: - client.products.list({ ...params }) -> ProductListResponsesDefaultPageNumberPagination - client.products.create({ ...params }) -> Product - client.products.retrieve(id) -> Product - client.products.update(id, { ...params }) -> void - client.products.archive(id) -> void - client.products.unarchive(id) -> void - client.products.updateFiles(id, { ...params }) -> ProductUpdateFilesResponse ## Images Types: - ImageUpdateResponse Methods: - client.products.images.update(id, { ...params }) -> ImageUpdateResponse ## ShortLinks Types: - ShortLinkCreateResponse - ShortLinkListResponse Methods: - client.products.shortLinks.list({ ...params }) -> ShortLinkListResponsesDefaultPageNumberPagination - client.products.shortLinks.create(id, { ...params }) -> ShortLinkCreateResponse ## LocalizedPrices Types: - ListLocalizedPricesResponse - LocalizedPrice - PricingMode Methods: - client.products.localizedPrices.list(productID) -> ListLocalizedPricesResponse - client.products.localizedPrices.create(productID, { ...params }) -> LocalizedPrice - client.products.localizedPrices.retrieve(id, { ...params }) -> LocalizedPrice - client.products.localizedPrices.update(id, { ...params }) -> LocalizedPrice - client.products.localizedPrices.archive(id, { ...params }) -> void # Misc Types: - CountryCode - Currency - Metadata - TaxCategory - MiscListSupportedCountriesResponse Methods: - client.misc.listSupportedCountries() -> MiscListSupportedCountriesResponse # Discounts Types: - Discount - DiscountDetail - DiscountType Methods: - client.discounts.list({ ...params }) -> DiscountsDefaultPageNumberPagination - client.discounts.create({ ...params }) -> Discount - client.discounts.retrieve(discountID) -> Discount - client.discounts.delete(discountID) -> void - client.discounts.update(discountID, { ...params }) -> Discount - client.discounts.retrieveByCode(code) -> Discount # Addons Types: - AddonResponse - AddonUpdateImagesResponse Methods: - client.addons.list({ ...params }) -> AddonResponsesDefaultPageNumberPagination - client.addons.create({ ...params }) -> AddonResponse - client.addons.retrieve(id) -> AddonResponse - client.addons.update(id, { ...params }) -> AddonResponse - client.addons.updateImages(id) -> AddonUpdateImagesResponse # Brands Types: - Brand - BrandListResponse - BrandUpdateImagesResponse Methods: - client.brands.list() -> BrandListResponse - client.brands.create({ ...params }) -> Brand - client.brands.retrieve(id) -> Brand - client.brands.update(id, { ...params }) -> Brand - client.brands.updateImages(id) -> BrandUpdateImagesResponse # Webhooks Types: - WebhookDetails - WebhookRetrieveSecretResponse - AbandonedCheckoutDetectedWebhookEvent - AbandonedCheckoutRecoveredWebhookEvent - CreditAddedWebhookEvent - CreditBalanceLowWebhookEvent - CreditDeductedWebhookEvent - CreditExpiredWebhookEvent - CreditManualAdjustmentWebhookEvent - CreditOverageChargedWebhookEvent - CreditOverageResetWebhookEvent - CreditRolledOverWebhookEvent - CreditRolloverForfeitedWebhookEvent - DisputeAcceptedWebhookEvent - DisputeCancelledWebhookEvent - DisputeChallengedWebhookEvent - DisputeExpiredWebhookEvent - DisputeLostWebhookEvent - DisputeOpenedWebhookEvent - DisputeWonWebhookEvent - DunningRecoveredWebhookEvent - DunningStartedWebhookEvent - EntitlementGrantCreatedWebhookEvent - EntitlementGrantDeliveredWebhookEvent - EntitlementGrantFailedWebhookEvent - EntitlementGrantRevokedWebhookEvent - LicenseKeyCreatedWebhookEvent - PaymentCancelledWebhookEvent - PaymentFailedWebhookEvent - PaymentProcessingWebhookEvent - PaymentSucceededWebhookEvent - RefundFailedWebhookEvent - RefundSucceededWebhookEvent - SubscriptionActiveWebhookEvent - SubscriptionCancelledWebhookEvent - SubscriptionExpiredWebhookEvent - SubscriptionFailedWebhookEvent - SubscriptionOnHoldWebhookEvent - SubscriptionPlanChangedWebhookEvent - SubscriptionRenewedWebhookEvent - SubscriptionUpdatePaymentMethodWebhookEvent - SubscriptionUpdatedWebhookEvent - AbandonedCheckoutDetectedWebhookEvent - AbandonedCheckoutRecoveredWebhookEvent - CreditAddedWebhookEvent - CreditBalanceLowWebhookEvent - CreditDeductedWebhookEvent - CreditExpiredWebhookEvent - CreditManualAdjustmentWebhookEvent - CreditOverageChargedWebhookEvent - CreditOverageResetWebhookEvent - CreditRolledOverWebhookEvent - CreditRolloverForfeitedWebhookEvent - DisputeAcceptedWebhookEvent - DisputeCancelledWebhookEvent - DisputeChallengedWebhookEvent - DisputeExpiredWebhookEvent - DisputeLostWebhookEvent - DisputeOpenedWebhookEvent - DisputeWonWebhookEvent - DunningRecoveredWebhookEvent - DunningStartedWebhookEvent - EntitlementGrantCreatedWebhookEvent - EntitlementGrantDeliveredWebhookEvent - EntitlementGrantFailedWebhookEvent - EntitlementGrantRevokedWebhookEvent - LicenseKeyCreatedWebhookEvent - PaymentCancelledWebhookEvent - PaymentFailedWebhookEvent - PaymentProcessingWebhookEvent - PaymentSucceededWebhookEvent - RefundFailedWebhookEvent - RefundSucceededWebhookEvent - SubscriptionActiveWebhookEvent - SubscriptionCancelledWebhookEvent - SubscriptionExpiredWebhookEvent - SubscriptionFailedWebhookEvent - SubscriptionOnHoldWebhookEvent - SubscriptionPlanChangedWebhookEvent - SubscriptionRenewedWebhookEvent - SubscriptionUpdatePaymentMethodWebhookEvent - SubscriptionUpdatedWebhookEvent - UnsafeUnwrapWebhookEvent - UnwrapWebhookEvent Methods: - client.webhooks.list({ ...params }) -> WebhookDetailsCursorPagePagination - client.webhooks.create({ ...params }) -> WebhookDetails - client.webhooks.retrieve(webhookID) -> WebhookDetails - client.webhooks.delete(webhookID) -> void - client.webhooks.update(webhookID, { ...params }) -> WebhookDetails - client.webhooks.retrieveSecret(webhookID) -> WebhookRetrieveSecretResponse - client.webhooks.unwrap(body) -> void - client.webhooks.unsafeUnwrap(body) -> void ## Headers Types: - HeaderRetrieveResponse Methods: - client.webhooks.headers.retrieve(webhookID) -> HeaderRetrieveResponse - client.webhooks.headers.update(webhookID, { ...params }) -> void # WebhookEvents Types: - WebhookEventType - WebhookPayload # UsageEvents Types: - Event - EventInput - UsageEventIngestResponse Methods: - client.usageEvents.ingest({ ...params }) -> UsageEventIngestResponse - client.usageEvents.list({ ...params }) -> EventsDefaultPageNumberPagination - client.usageEvents.retrieve(eventID) -> Event # Meters Types: - Conjunction - FilterOperator - FilterType - Meter - MeterAggregation - MeterFilter Methods: - client.meters.list({ ...params }) -> MetersDefaultPageNumberPagination - client.meters.create({ ...params }) -> Meter - client.meters.retrieve(id) -> Meter - client.meters.archive(id) -> void - client.meters.unarchive(id) -> void # Balances Types: - BalanceLedgerEntry Methods: - client.balances.retrieveLedger({ ...params }) -> BalanceLedgerEntriesDefaultPageNumberPagination # CreditEntitlements Types: - CbbOverageBehavior - CreditEntitlement Methods: - client.creditEntitlements.list({ ...params }) -> CreditEntitlementsDefaultPageNumberPagination - client.creditEntitlements.create({ ...params }) -> CreditEntitlement - client.creditEntitlements.retrieve(id) -> CreditEntitlement - client.creditEntitlements.delete(id) -> void - client.creditEntitlements.update(id, { ...params }) -> void - client.creditEntitlements.undelete(id) -> void ## Balances Types: - CreditLedgerEntry - CustomerCreditBalance - LedgerEntryType - BalanceCreateLedgerEntryResponse - BalanceListGrantsResponse Methods: -

client.creditEntitlements.balances.list(creditEntitlementID, { ...params }) -> CustomerCreditBalancesDefaultPageNumberPagination

- client.creditEntitlements.balances.retrieve(customerID, { ...params }) -> CustomerCreditBalance -

client.creditEntitlements.balances.listGrants(customerID, { ...params }) -> BalanceListGrantsResponsesDefaultPageNumberPagination

client.creditEntitlements.balances.listLedger(customerID, { ...params }) -> CreditLedgerEntriesDefaultPageNumberPagination

- client.creditEntitlements.balances.createLedgerEntry(customerID, { ...params }) -> BalanceCreateLedgerEntryResponse # Entitlements Types: - Entitlement - EntitlementIntegrationType - Feature - FeatureType - GitHubPermission - IntegrationConfig - IntegrationConfigResponse Methods: - client.entitlements.list({ ...params }) -> EntitlementsDefaultPageNumberPagination - client.entitlements.create({ ...params }) -> Entitlement - client.entitlements.retrieve(id) -> Entitlement - client.entitlements.delete(id) -> void - client.entitlements.update(id, { ...params }) -> Entitlement ## Files Types: - FileUploadResponse Methods: - client.entitlements.files.upload(id) -> FileUploadResponse - client.entitlements.files.delete(fileID, { ...params }) -> void ## Grants Types: - EntitlementGrant - LicenseKeyGrant Methods: - client.entitlements.grants.list(id, { ...params }) -> EntitlementGrantsDefaultPageNumberPagination - client.entitlements.grants.revoke(grantID, { ...params }) -> EntitlementGrant - client.entitlements.grants.fulfillLicenseKey(grantID, { ...params }) -> EntitlementGrant # ProductCollections Types: - ProductCollection - ProductCollectionListResponse - ProductCollectionUnarchiveResponse - ProductCollectionUpdateImagesResponse Methods: - client.productCollections.list({ ...params }) -> ProductCollectionListResponsesDefaultPageNumberPagination - client.productCollections.create({ ...params }) -> ProductCollection - client.productCollections.retrieve(id) -> ProductCollection - client.productCollections.delete(id) -> void - client.productCollections.update(id, { ...params }) -> void - client.productCollections.updateImages(id, { ...params }) -> ProductCollectionUpdateImagesResponse - client.productCollections.unarchive(id) -> ProductCollectionUnarchiveResponse ## Groups Types: - GroupProduct - ProductCollectionGroupDetails - ProductCollectionGroupResponse Methods: - client.productCollections.groups.create(id, { ...params }) -> ProductCollectionGroupResponse - client.productCollections.groups.delete(groupID, { ...params }) -> void - client.productCollections.groups.update(groupID, { ...params }) -> void ### Items Types: - ProductCollectionProduct - ItemCreateResponse Methods: - client.productCollections.groups.items.create(groupID, { ...params }) -> ItemCreateResponse - client.productCollections.groups.items.delete(itemID, { ...params }) -> void - client.productCollections.groups.items.update(itemID, { ...params }) -> void