https://github.com/pfpayments/php-sdk
PHP SDK for PostFinance Checkout
https://github.com/pfpayments/php-sdk
composer payment payment-integration php php-sdk postfinance postfinance-checkout postfinance-checkout-sdk
Last synced: 29 days ago
JSON representation
PHP SDK for PostFinance Checkout
- Host: GitHub
- URL: https://github.com/pfpayments/php-sdk
- Owner: pfpayments
- License: apache-2.0
- Created: 2018-07-04T10:10:49.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2026-02-03T09:18:47.000Z (3 months ago)
- Last Synced: 2026-02-03T22:11:47.924Z (3 months ago)
- Topics: composer, payment, payment-integration, php, php-sdk, postfinance, postfinance-checkout, postfinance-checkout-sdk
- Language: PHP
- Homepage: https://www.postfinance-checkout.ch
- Size: 3.78 MB
- Stars: 22
- Watchers: 7
- Forks: 5
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PostFinanceCheckout PHP SDK
- API version: 2.0
The PostFinanceCheckout PHP SDK is used to interact with PostFinanceCheckout's REST API.
## Requirements
PHP 8.2 or later.
## Compatibility
| PHP SDK version | PHP version | Supported until |
|-----------------|---------------|-----------------|
| 5.x | 8.2 or later | Further notice |
| 4.x | 5.6 – 7.3 | Fall 2026 |
## Installation
### Composer
The preferred method is via [composer](https://getcomposer.org). Follow the
[installation instructions](https://getcomposer.org/doc/00-intro.md) if you do not already have
composer installed.
Once composer is installed, execute the following command in your project root to install this library:
```sh
composer require postfinancecheckout/sdk
```
## Getting Started
Please follow the [installation](#installation) instructions, then run the following example:
```php
getPaymentTransactionsId($transactionId, $spaceId, $expandSet);
print_r($transaction);
} catch (Exception $e) {
echo 'Exception when calling api: ', $e->getMessage(), PHP_EOL;
}
```
## Documentation for API Endpoints
Additional Api services documentation: [*link*](https://checkout.postfinance.ch/en-us/doc/api/web-service#_services)
Web Api client: [*link*](https://checkout.postfinance.ch//api/client)
Click here to see full list of services
All URIs are relative to https://checkout.postfinance.ch/
(click on method name to see web doc)
API Services:
- AccountsService
* deleteAccountsId
DELETE /accounts/{id}
Delete an account
- AccountsService
* getAccounts
GET /accounts
List all accounts
- AccountsService
* getAccountsId
GET /accounts/{id}
Retrieve an account
- AccountsService
* getAccountsSearch
GET /accounts/search
Search accounts
- AccountsService
* patchAccountsId
PATCH /accounts/{id}
Update an account
- AccountsService
* postAccounts
POST /accounts
Create an account
- AccountsService
* postAccountsIdActivate
POST /accounts/{id}/activate
Activate an account
- AccountsService
* postAccountsIdDeactivate
POST /accounts/{id}/deactivate
Deactivate an account
- AnalyticsQueriesService
* deleteAnalyticsQueriesQueryExternalIdQueryExternalId
DELETE /analytics/queries/queryExternalId/{queryExternalId}
Cancel a query execution, identifying it by its external id.
- AnalyticsQueriesService
* deleteAnalyticsQueriesQueryTokenQueryToken
DELETE /analytics/queries/queryToken/{queryToken}
Cancel a query execution, identifying it by its query token.
- AnalyticsQueriesService
* getAnalyticsQueries
GET /analytics/queries
Get portion of query executions for account
- AnalyticsQueriesService
* getAnalyticsQueriesQueryExternalIdQueryExternalId
GET /analytics/queries/queryExternalId/{queryExternalId}
Retrieve a query execution information by its external id
- AnalyticsQueriesService
* getAnalyticsQueriesQueryExternalIdQueryExternalIdResult
GET /analytics/queries/queryExternalId/{queryExternalId}/result
Generate a temporary URL to download the query result. It retrieves the query by its external id
- AnalyticsQueriesService
* getAnalyticsQueriesQueryTokenQueryToken
GET /analytics/queries/queryToken/{queryToken}
Retrieve a query execution information by its query token
- AnalyticsQueriesService
* getAnalyticsQueriesQueryTokenQueryTokenResult
GET /analytics/queries/queryToken/{queryToken}/result
Generate a temporary URL to download the query result. It retrieves the query by its query token
- AnalyticsQueriesService
* postAnalyticsQueriesSubmit
POST /analytics/queries/submit
Submit a query execution
- ApplicationUsersService
* deleteApplicationUsersId
DELETE /application-users/{id}
Delete an application user
- ApplicationUsersService
* deleteApplicationUsersUserIdKeysId
DELETE /application-users/{userId}/keys/{id}
Deactivate an authentication key
- ApplicationUsersService
* getApplicationUsers
GET /application-users
List all application users
- ApplicationUsersService
* getApplicationUsersId
GET /application-users/{id}
Retrieve an application user
- ApplicationUsersService
* getApplicationUsersSearch
GET /application-users/search
Search application users
- ApplicationUsersService
* getApplicationUsersUserIdKeys
GET /application-users/{userId}/keys
List a user's authentication keys
- ApplicationUsersService
* patchApplicationUsersId
PATCH /application-users/{id}
Update an application user
- ApplicationUsersService
* postApplicationUsers
POST /application-users
Create an application user
- ApplicationUsersService
* postApplicationUsersUserIdKeys
POST /application-users/{userId}/keys
Generate a new authentication key
- ApplicationUsersRolesService
* deleteApplicationUsersUserIdAccountRoles
DELETE /application-users/{userId}/account-roles
Unassign a role from an application user for an account
- ApplicationUsersRolesService
* deleteApplicationUsersUserIdSpaceRoles
DELETE /application-users/{userId}/space-roles
Unassign a role from an application user for a space
- ApplicationUsersRolesService
* getApplicationUsersUserIdAccountRoles
GET /application-users/{userId}/account-roles
List all roles of an application user for an account
- ApplicationUsersRolesService
* getApplicationUsersUserIdSpaceRoles
GET /application-users/{userId}/space-roles
List all roles of an application user for a space
- ApplicationUsersRolesService
* postApplicationUsersUserIdAccountRoles
POST /application-users/{userId}/account-roles
Assign a role to an application user for an account
- ApplicationUsersRolesService
* postApplicationUsersUserIdSpaceRoles
POST /application-users/{userId}/space-roles
Assign a role to an application user for a space
- BankAccountsService
* getPaymentBankAccounts
GET /payment/bank-accounts
List all bank accounts
- BankAccountsService
* getPaymentBankAccountsId
GET /payment/bank-accounts/{id}
Retrieve a bank account
- BankAccountsService
* getPaymentBankAccountsSearch
GET /payment/bank-accounts/search
Search bank accounts
- BankTransactionsService
* getPaymentBankTransactions
GET /payment/bank-transactions
List all bank transactions
- BankTransactionsService
* getPaymentBankTransactionsId
GET /payment/bank-transactions/{id}
Retrieve a bank transaction
- BankTransactionsService
* getPaymentBankTransactionsSearch
GET /payment/bank-transactions/search
Search bank transactions
- BoardingSubscriptionStrategyService
* postBoardingSubscriptionStrategyInformation
POST /boarding/subscription-strategy/information
Create a boarding subscription information for an account
- BoardingSubscriptionStrategyService
* postBoardingSubscriptionStrategyPlans
POST /boarding/subscription-strategy/plans
Create new Boarding Trial Subscription to Account
- ChargeAttemptsService
* getPaymentChargeAttempts
GET /payment/charge-attempts
List all charge attempts
- ChargeAttemptsService
* getPaymentChargeAttemptsId
GET /payment/charge-attempts/{id}
Retrieve a charge attempt
- ChargeAttemptsService
* getPaymentChargeAttemptsSearch
GET /payment/charge-attempts/search
Search charge attempts
- ChargeBankTransactionsService
* getPaymentBankTransactionsCharges
GET /payment/bank-transactions/charges
List all charge bank transactions
- ChargeBankTransactionsService
* getPaymentBankTransactionsChargesId
GET /payment/bank-transactions/charges/{id}
Retrieve a charge bank transaction
- ChargeBankTransactionsService
* getPaymentBankTransactionsChargesSearch
GET /payment/bank-transactions/charges/search
Search charge bank transactions
- ChargeFlowLevelsService
* getPaymentChargeFlowsLevels
GET /payment/charge-flows/levels
List all charge flow levels
- ChargeFlowLevelsService
* getPaymentChargeFlowsLevelsId
GET /payment/charge-flows/levels/{id}
Retrieve a charge flow level
- ChargeFlowLevelsService
* getPaymentChargeFlowsLevelsSearch
GET /payment/charge-flows/levels/search
Search charge flow levels
- ChargeFlowLevelsService
* postPaymentChargeFlowsLevelsIdSendMessage
POST /payment/charge-flows/levels/{id}/send-message
Send a payment link
- ChargeFlowsService
* getPaymentChargeFlows
GET /payment/charge-flows
List all charge flows
- ChargeFlowsService
* getPaymentChargeFlowsId
GET /payment/charge-flows/{id}
Retrieve a charge flow
- ChargeFlowsService
* getPaymentChargeFlowsSearch
GET /payment/charge-flows/search
Search charge flows
- ChargeFlowsLevelPaymentLinksService
* getPaymentChargeFlowsLevelsPaymentLinks
GET /payment/charge-flows/levels/payment-links
List all charge flow payment links
- ChargeFlowsLevelPaymentLinksService
* getPaymentChargeFlowsLevelsPaymentLinksId
GET /payment/charge-flows/levels/payment-links/{id}
Retrieve a charge flow payment link
- ChargeFlowsLevelPaymentLinksService
* getPaymentChargeFlowsLevelsPaymentLinksSearch
GET /payment/charge-flows/levels/payment-links/search
Search charge flow payment links
- ConditionTypesService
* getPaymentConditionTypes
GET /payment/condition-types
List all condition types.
- ConditionTypesService
* getPaymentConditionTypesId
GET /payment/condition-types/{id}
Retrieve a condition type.
- ConditionTypesService
* getPaymentConditionTypesSearch
GET /payment/condition-types/search
Search condition types.
- CountriesService
* getCountries
GET /countries
List all countries
- CountriesService
* getCountriesCode
GET /countries/{code}
Retrieve a country
- CountriesService
* getCountriesCountryCodeStates
GET /countries/{countryCode}/states
List all states for a country
- CountriesService
* getCountriesSearch
GET /countries/search
Search countries
- CountriesService
* getCountriesStates
GET /countries/states
List all country states
- CountriesService
* getCountriesStatesId
GET /countries/states/{id}
Retrieve a country state
- CurrenciesService
* getCurrencies
GET /currencies
List all currencies
- CurrenciesService
* getCurrenciesCode
GET /currencies/{code}
Retrieve a currency
- CurrenciesService
* getCurrenciesSearch
GET /currencies/search
Search currencies
- CurrencyBankAccountsService
* getPaymentCurrencyBankAccounts
GET /payment/currency-bank-accounts
List all currency bank accounts
- CurrencyBankAccountsService
* getPaymentCurrencyBankAccountsId
GET /payment/currency-bank-accounts/{id}
Retrieve a currency bank account
- CurrencyBankAccountsService
* getPaymentCurrencyBankAccountsSearch
GET /payment/currency-bank-accounts/search
Search currency bank accounts
- CustomerAddressesService
* deleteCustomersCustomerIdAddressesId
DELETE /customers/{customerId}/addresses/{id}
Delete a customer address
- CustomerAddressesService
* getCustomersCustomerIdAddresses
GET /customers/{customerId}/addresses
List all customer addresses
- CustomerAddressesService
* getCustomersCustomerIdAddressesId
GET /customers/{customerId}/addresses/{id}
Retrieve a customer address
- CustomerAddressesService
* getCustomersCustomerIdAddressesSearch
GET /customers/{customerId}/addresses/search
Search customer addresses
- CustomerAddressesService
* patchCustomersCustomerIdAddressesId
PATCH /customers/{customerId}/addresses/{id}
Update a customer address
- CustomerAddressesService
* postCustomersCustomerIdAddresses
POST /customers/{customerId}/addresses
Create a customer address
- CustomerAddressesService
* postCustomersCustomerIdAddressesIdDefault
POST /customers/{customerId}/addresses/{id}/default
Set the default address for a customer
- CustomerCommentsService
* deleteCustomersCustomerIdCommentsId
DELETE /customers/{customerId}/comments/{id}
Delete a customer comment
- CustomerCommentsService
* getCustomersCustomerIdComments
GET /customers/{customerId}/comments
List all customer comments
- CustomerCommentsService
* getCustomersCustomerIdCommentsId
GET /customers/{customerId}/comments/{id}
Retrieve a customer comment
- CustomerCommentsService
* getCustomersCustomerIdCommentsSearch
GET /customers/{customerId}/comments/search
Search customer comments
- CustomerCommentsService
* patchCustomersCustomerIdCommentsId
PATCH /customers/{customerId}/comments/{id}
Update a customer comment
- CustomerCommentsService
* postCustomersCustomerIdComments
POST /customers/{customerId}/comments
Create a customer comment
- CustomerCommentsService
* postCustomersCustomerIdCommentsIdPin
POST /customers/{customerId}/comments/{id}/pin
Pin a comment to the top
- CustomerCommentsService
* postCustomersCustomerIdCommentsIdUnpin
POST /customers/{customerId}/comments/{id}/unpin
Remove a pinned comment from the top
- CustomersService
* deleteCustomersBulk
DELETE /customers/bulk
Delete multiple customers
- CustomersService
* deleteCustomersId
DELETE /customers/{id}
Delete a customer
- CustomersService
* getCustomers
GET /customers
List all customers
- CustomersService
* getCustomersId
GET /customers/{id}
Retrieve a customer
- CustomersService
* getCustomersIdEmailAddresses
GET /customers/{id}/email-addresses
List a customer's email addresses
- CustomersService
* getCustomersSearch
GET /customers/search
Search customers
- CustomersService
* patchCustomersBulk
PATCH /customers/bulk
Update multiple customers
- CustomersService
* patchCustomersId
PATCH /customers/{id}
Update a customer
- CustomersService
* postCustomers
POST /customers
Create a customer
- CustomersService
* postCustomersBulk
POST /customers/bulk
Create multiple customers
- CustomersService
* postCustomersIdMergeOther
POST /customers/{id}/merge/{other}
Merge two customers
- DeliveryIndicationsService
* getPaymentDeliveryIndications
GET /payment/delivery-indications
List all delivery indications
- DeliveryIndicationsService
* getPaymentDeliveryIndicationsId
GET /payment/delivery-indications/{id}
Retrieve a delivery indication
- DeliveryIndicationsService
* getPaymentDeliveryIndicationsSearch
GET /payment/delivery-indications/search
Search delivery indications
- DeliveryIndicationsService
* postPaymentDeliveryIndicationsIdMarkNotSuitable
POST /payment/delivery-indications/{id}/mark-not-suitable
Mark a delivery indication as not suitable.
- DeliveryIndicationsService
* postPaymentDeliveryIndicationsIdMarkSuitable
POST /payment/delivery-indications/{id}/mark-suitable
Mark a delivery indication as suitable.
- DocumentTemplateTypesService
* getDocumentTemplatesTypes
GET /document-templates/types
List all document template types
- DocumentTemplateTypesService
* getDocumentTemplatesTypesId
GET /document-templates/types/{id}
Retrieve a document template type
- DocumentTemplateTypesService
* getDocumentTemplatesTypesSearch
GET /document-templates/types/search
Search document template types
- DocumentTemplatesService
* getDocumentTemplates
GET /document-templates
List all document templates
- DocumentTemplatesService
* getDocumentTemplatesId
GET /document-templates/{id}
Retrieve a document template
- DocumentTemplatesService
* getDocumentTemplatesSearch
GET /document-templates/search
Search document templates
- DunningCasesService
* getPaymentDunningCases
GET /payment/dunning-cases
List all dunning cases
- DunningCasesService
* getPaymentDunningCasesId
GET /payment/dunning-cases/{id}
Retrieve a dunning case
- DunningCasesService
* getPaymentDunningCasesSearch
GET /payment/dunning-cases/search
Search dunning cases
- DunningCasesService
* postPaymentDunningCasesIdSuspend
POST /payment/dunning-cases/{id}/suspend
Suspend a dunning case
- DunningCasesService
* postPaymentDunningCasesInvoiceInvoiceId
POST /payment/dunning-cases/invoice/{invoiceId}
Create a dunning case for an invoice
- DunningFlowLevelsService
* getPaymentDunningFlowsLevels
GET /payment/dunning-flows/levels
List all dunning flow levels
- DunningFlowLevelsService
* getPaymentDunningFlowsLevelsId
GET /payment/dunning-flows/levels/{id}
Retrieve a dunning flow level
- DunningFlowLevelsService
* getPaymentDunningFlowsLevelsSearch
GET /payment/dunning-flows/levels/search
Search dunning flow levels
- DunningFlowsService
* getPaymentDunningFlows
GET /payment/dunning-flows
List all dunning flows
- DunningFlowsService
* getPaymentDunningFlowsId
GET /payment/dunning-flows/{id}
Retrieve a dunning flow
- DunningFlowsService
* getPaymentDunningFlowsSearch
GET /payment/dunning-flows/search
Search dunning flows
- ExternalTransferBankTransactionsService
* getPaymentBankTransactionsExternalTransfers
GET /payment/bank-transactions/external-transfers
List all external transfer bank transactions
- ExternalTransferBankTransactionsService
* getPaymentBankTransactionsExternalTransfersId
GET /payment/bank-transactions/external-transfers/{id}
Retrieve an external transfer bank transaction
- ExternalTransferBankTransactionsService
* getPaymentBankTransactionsExternalTransfersSearch
GET /payment/bank-transactions/external-transfers/search
Search external transfer bank transactions
- HumanUsersService
* deleteHumanUsersId
DELETE /human-users/{id}
Delete a human user
- HumanUsersService
* getHumanUsers
GET /human-users
List all human users
- HumanUsersService
* getHumanUsersExport
GET /human-users/export
Export human users
- HumanUsersService
* getHumanUsersId
GET /human-users/{id}
Retrieve a human user
- HumanUsersService
* getHumanUsersSearch
GET /human-users/search
Search human users
- HumanUsersService
* patchHumanUsersId
PATCH /human-users/{id}
Update a human user
- HumanUsersService
* postHumanUsers
POST /human-users
Create a human user
- HumanUsersRolesService
* deleteHumanUsersUserIdAccountRoles
DELETE /human-users/{userId}/account-roles
Unassign a role from a human user for an account
- HumanUsersRolesService
* deleteHumanUsersUserIdSpaceRoles
DELETE /human-users/{userId}/space-roles
Unassign a role from a human user for a space
- HumanUsersRolesService
* getHumanUsersUserIdAccountRoles
GET /human-users/{userId}/account-roles
List all roles of a human user for an account
- HumanUsersRolesService
* getHumanUsersUserIdSpaceRoles
GET /human-users/{userId}/space-roles
List all roles of a human user for a space
- HumanUsersRolesService
* postHumanUsersUserIdAccountRoles
POST /human-users/{userId}/account-roles
Assign a role to a human user for an account
- HumanUsersRolesService
* postHumanUsersUserIdSpaceRoles
POST /human-users/{userId}/space-roles
Assign a role to a human user for a space
- InternalTransferBankTransactionsService
* getPaymentBankTransactionsInternalTransfers
GET /payment/bank-transactions/internal-transfers
List all internal transfer bank transactions
- InternalTransferBankTransactionsService
* getPaymentBankTransactionsInternalTransfersId
GET /payment/bank-transactions/internal-transfers/{id}
Retrieve an internal transfer bank transaction
- InternalTransferBankTransactionsService
* getPaymentBankTransactionsInternalTransfersSearch
GET /payment/bank-transactions/internal-transfers/search
Search internal transfer bank transactions
- JoinAdminPartnerConfigurationService
* deleteAdminJoinProgramPartnersConfigurationsId
DELETE /admin/join-program/partners/configurations/{id}
Delete a join admin partner configuration
- JoinAdminPartnerConfigurationService
* getAdminJoinProgramPartnersConfigurationsId
GET /admin/join-program/partners/configurations/{id}
Retrieve a join admin partner configuration
- JoinAdminPartnerConfigurationService
* patchAdminJoinProgramPartnersConfigurationsId
PATCH /admin/join-program/partners/configurations/{id}
Update a join admin partner configuration
- JoinAdminPartnerConfigurationService
* postAdminJoinProgramPartnersConfigurations
POST /admin/join-program/partners/configurations
Create a join admin partner configuration
- JoinPartnershipService
* deleteJoinProgramPartnershipsId
DELETE /join-program/partnerships/{id}
Delete a join partnership
- JoinPartnershipService
* getJoinProgramPartnerships
GET /join-program/partnerships
List all join partnerships
- JoinPartnershipService
* getJoinProgramPartnershipsId
GET /join-program/partnerships/{id}
Retrieve a join partnership
- JoinPartnershipService
* getJoinProgramPartnershipsSearch
GET /join-program/partnerships/search
Search join partnerships
- JoinPartnershipService
* patchJoinProgramPartnershipsId
PATCH /join-program/partnerships/{id}
Update a join partnership
- JoinPartnershipService
* postJoinProgramPartnershipsCreateAffiliate
POST /join-program/partnerships/create-affiliate
Create a join account partnership
- JoinPartnershipService
* postJoinProgramPartnershipsCreateIsv
POST /join-program/partnerships/create-isv
Create a join platform partnership
- JoinPartnershipService
* postJoinProgramPartnershipsCreateSimple
POST /join-program/partnerships/create-simple
Create a join partnership for an existing merchant
- LabelDescriptorsService
* getLabelDescriptors
GET /label-descriptors
List all label descriptors
- LabelDescriptorsService
* getLabelDescriptorsGroups
GET /label-descriptors/groups
List all label descriptor groups
- LabelDescriptorsService
* getLabelDescriptorsGroupsId
GET /label-descriptors/groups/{id}
Retrieve a label descriptor group
- LabelDescriptorsService
* getLabelDescriptorsGroupsSearch
GET /label-descriptors/groups/search
Search label descriptor groups
- LabelDescriptorsService
* getLabelDescriptorsId
GET /label-descriptors/{id}
Retrieve a label descriptor
- LabelDescriptorsService
* getLabelDescriptorsSearch
GET /label-descriptors/search
Search label descriptors
- LanguagesService
* getLanguages
GET /languages
List all languages
- LanguagesService
* getLanguagesCode
GET /languages/{code}
Retrieve a language
- LanguagesService
* getLanguagesSearch
GET /languages/search
Search languages
- LegalOrganizationFormsService
* getLegalOrganizationForms
GET /legal-organization-forms
List all legal organization forms
- LegalOrganizationFormsService
* getLegalOrganizationFormsId
GET /legal-organization-forms/{id}
Retrieve a legal organization form
- LegalOrganizationFormsService
* getLegalOrganizationFormsSearch
GET /legal-organization-forms/search
Search legal organization forms
- ManualTasksService
* getManualTasks
GET /manual-tasks
List all manual tasks
- ManualTasksService
* getManualTasksId
GET /manual-tasks/{id}
Retrieve a manual task
- ManualTasksService
* getManualTasksIdNotification
GET /manual-tasks/{id}/notification
Retrieve a manual task's notification message
- ManualTasksService
* getManualTasksSearch
GET /manual-tasks/search
Search manual tasks
- ManualTasksService
* postManualTasksIdActionActionId
POST /manual-tasks/{id}/action/{actionId}
Process a manual task's action
- PaymentConnectorConfigurationsService
* deletePaymentConnectorConfigurationsId
DELETE /payment/connector-configurations/{id}
Delete a payment connector configuration
- PaymentConnectorConfigurationsService
* getPaymentConnectorConfigurations
GET /payment/connector-configurations
List all payment connector configurations
- PaymentConnectorConfigurationsService
* getPaymentConnectorConfigurationsId
GET /payment/connector-configurations/{id}
Retrieve a payment connector configuration
- PaymentConnectorConfigurationsService
* getPaymentConnectorConfigurationsSearch
GET /payment/connector-configurations/search
Search payment connector configurations
- PaymentConnectorConfigurationsService
* patchPaymentConnectorConfigurationsId
PATCH /payment/connector-configurations/{id}
Update a payment connector configuration
- PaymentConnectorConfigurationsService
* postPaymentConnectorConfigurations
POST /payment/connector-configurations
Create a payment connector configuration
- PaymentConnectorsService
* getPaymentConnectors
GET /payment/connectors
List all payment connectors.
- PaymentConnectorsService
* getPaymentConnectorsId
GET /payment/connectors/{id}
Retrieve a payment connector.
- PaymentConnectorsService
* getPaymentConnectorsSearch
GET /payment/connectors/search
Search payment connectors.
- PaymentLinksService
* deletePaymentLinksId
DELETE /payment/links/{id}
Delete a payment link
- PaymentLinksService
* getPaymentLinks
GET /payment/links
List all payment links
- PaymentLinksService
* getPaymentLinksId
GET /payment/links/{id}
Retrieve a payment link
- PaymentLinksService
* getPaymentLinksSearch
GET /payment/links/search
Search payment links
- PaymentLinksService
* patchPaymentLinksId
PATCH /payment/links/{id}
Update a payment link
- PaymentLinksService
* postPaymentLinks
POST /payment/links
Create a payment link
- PaymentMethodBrandsService
* getPaymentMethodBrands
GET /payment/method-brands
List all payment method brands.
- PaymentMethodBrandsService
* getPaymentMethodBrandsId
GET /payment/method-brands/{id}
Retrieve a payment method brand.
- PaymentMethodBrandsService
* getPaymentMethodBrandsSearch
GET /payment/method-brands/search
Search payment method brands.
- PaymentMethodConfigurationsService
* deletePaymentMethodConfigurationsId
DELETE /payment/method-configurations/{id}
Delete a payment method configuration
- PaymentMethodConfigurationsService
* getPaymentMethodConfigurations
GET /payment/method-configurations
List all payment method configurations
- PaymentMethodConfigurationsService
* getPaymentMethodConfigurationsId
GET /payment/method-configurations/{id}
Retrieve a payment method configuration
- PaymentMethodConfigurationsService
* getPaymentMethodConfigurationsSearch
GET /payment/method-configurations/search
Search payment method configurations
- PaymentMethodConfigurationsService
* patchPaymentMethodConfigurationsId
PATCH /payment/method-configurations/{id}
Update a payment method configuration
- PaymentMethodConfigurationsService
* postPaymentMethodConfigurations
POST /payment/method-configurations
Create a payment method configuration
- PaymentMethodsService
* getPaymentMethods
GET /payment/methods
List all payment methods.
- PaymentMethodsService
* getPaymentMethodsId
GET /payment/methods/{id}
Retrieve a payment method.
- PaymentMethodsService
* getPaymentMethodsSearch
GET /payment/methods/search
Search payment methods.
- PaymentProcessorConfigurationsService
* deletePaymentProcessorConfigurationsId
DELETE /payment/processor-configurations/{id}
Delete a payment processor configuration
- PaymentProcessorConfigurationsService
* getPaymentProcessorConfigurations
GET /payment/processor-configurations
List all payment processor configurations
- PaymentProcessorConfigurationsService
* getPaymentProcessorConfigurationsId
GET /payment/processor-configurations/{id}
Retrieve a payment processor configuration
- PaymentProcessorConfigurationsService
* getPaymentProcessorConfigurationsSearch
GET /payment/processor-configurations/search
Search payment processor configurations
- PaymentProcessorConfigurationsService
* patchPaymentProcessorConfigurationsId
PATCH /payment/processor-configurations/{id}
Update a payment processor configuration
- PaymentProcessorConfigurationsService
* postPaymentProcessorConfigurations
POST /payment/processor-configurations
Create a payment processor configuration
- PaymentProcessorConfigurationsService
* postPaymentProcessorConfigurationsIdLinkContract
POST /payment/processor-configurations/{id}/link-contract
Link a contract with a payment processor configuration
- PaymentProcessorsService
* getPaymentProcessors
GET /payment/processors
List all payment processors.
- PaymentProcessorsService
* getPaymentProcessorsId
GET /payment/processors/{id}
Retrieve a payment processor.
- PaymentProcessorsService
* getPaymentProcessorsSearch
GET /payment/processors/search
Search payment processors.
- PaymentSalesChannelsService
* getPaymentSalesChannels
GET /payment/sales-channels
List all payment sales channels.
- PaymentSalesChannelsService
* getPaymentSalesChannelsId
GET /payment/sales-channels/{id}
Retrieve a payment sales channel.
- PaymentSalesChannelsService
* getPaymentSalesChannelsSearch
GET /payment/sales-channels/search
Search payment sales channels.
- PaymentTerminalTransactionSummariesService
* getPaymentTerminalsTransactionSummaries
GET /payment/terminals/transaction-summaries
List all summaries
- PaymentTerminalTransactionSummariesService
* getPaymentTerminalsTransactionSummariesId
GET /payment/terminals/transaction-summaries/{id}
Retrieve a summary
- PaymentTerminalTransactionSummariesService
* getPaymentTerminalsTransactionSummariesIdReceipt
GET /payment/terminals/transaction-summaries/{id}/receipt
Retrieve a rendered summary receipt
- PaymentTerminalTransactionSummariesService
* getPaymentTerminalsTransactionSummariesSearch
GET /payment/terminals/transaction-summaries/search
Search summaries
- PaymentTerminalsService
* deletePaymentTerminalsId
DELETE /payment/terminals/{id}
Delete a payment terminal
- PaymentTerminalsService
* getPaymentTerminals
GET /payment/terminals
List all payment terminals
- PaymentTerminalsService
* getPaymentTerminalsId
GET /payment/terminals/{id}
Retrieve a payment terminal
- PaymentTerminalsService
* getPaymentTerminalsIdTillConnectionCredentials
GET /payment/terminals/{id}/till-connection-credentials
Retrieve till connection credentials
- PaymentTerminalsService
* getPaymentTerminalsSearch
GET /payment/terminals/search
Search payment terminals
- PaymentTerminalsService
* patchPaymentTerminalsId
PATCH /payment/terminals/{id}
Update a payment terminal
- PaymentTerminalsService
* postPaymentTerminals
POST /payment/terminals
Create a payment terminal
- PaymentTerminalsService
* postPaymentTerminalsByIdentifierIdentifierPerformTransaction
POST /payment/terminals/by-identifier/{identifier}/perform-transaction
Perform a payment terminal transaction by identifier
- PaymentTerminalsService
* postPaymentTerminalsByIdentifierIdentifierTriggerConfiguration
POST /payment/terminals/by-identifier/{identifier}/trigger-configuration
Remotely trigger the configuration by identifier
- PaymentTerminalsService
* postPaymentTerminalsByIdentifierIdentifierTriggerFinalBalance
POST /payment/terminals/by-identifier/{identifier}/trigger-final-balance
Remotely trigger the final balance by identifier
- PaymentTerminalsService
* postPaymentTerminalsIdLink
POST /payment/terminals/{id}/link
Link a device with a payment terminal
- PaymentTerminalsService
* postPaymentTerminalsIdPerformTransaction
POST /payment/terminals/{id}/perform-transaction
Perform a payment terminal transaction
- PaymentTerminalsService
* postPaymentTerminalsIdTriggerConfiguration
POST /payment/terminals/{id}/trigger-configuration
Remotely trigger the configuration
- PaymentTerminalsService
* postPaymentTerminalsIdTriggerFinalBalance
POST /payment/terminals/{id}/trigger-final-balance
Remotely trigger the final balance
- PaymentTerminalsService
* postPaymentTerminalsIdUnlink
POST /payment/terminals/{id}/unlink
Unlink any device from a payment terminal
- PermissionsService
* getPermissions
GET /permissions
List all permissions
- PermissionsService
* getPermissionsId
GET /permissions/{id}
Retrieve a permission
- PermissionsService
* getPermissionsSearch
GET /permissions/search
Search permissions
- RefundBankTransactionsService
* getPaymentBankTransactionsRefunds
GET /payment/bank-transactions/refunds
List all refund bank transactions
- RefundBankTransactionsService
* getPaymentBankTransactionsRefundsId
GET /payment/bank-transactions/refunds/{id}
Retrieve a refund bank transaction
- RefundBankTransactionsService
* getPaymentBankTransactionsRefundsSearch
GET /payment/bank-transactions/refunds/search
Search refund bank transactions
- RefundCommentsService
* deletePaymentRefundsRefundIdCommentsId
DELETE /payment/refunds/{refundId}/comments/{id}
Delete a refund comment
- RefundCommentsService
* getPaymentRefundsRefundIdComments
GET /payment/refunds/{refundId}/comments
List all refund comments
- RefundCommentsService
* getPaymentRefundsRefundIdCommentsId
GET /payment/refunds/{refundId}/comments/{id}
Retrieve a refund comment
- RefundCommentsService
* getPaymentRefundsRefundIdCommentsSearch
GET /payment/refunds/{refundId}/comments/search
Search refund comments
- RefundCommentsService
* patchPaymentRefundsRefundIdCommentsId
PATCH /payment/refunds/{refundId}/comments/{id}
Update a refund comment
- RefundCommentsService
* postPaymentRefundsRefundIdComments
POST /payment/refunds/{refundId}/comments
Create a refund comment
- RefundCommentsService
* postPaymentRefundsRefundIdCommentsIdPin
POST /payment/refunds/{refundId}/comments/{id}/pin
Pin a comment to the top
- RefundCommentsService
* postPaymentRefundsRefundIdCommentsIdUnpin
POST /payment/refunds/{refundId}/comments/{id}/unpin
Remove the pinned comment from the top
- RefundRecoveryBankTransactionsService
* getPaymentBankTransactionsRefundRecoveries
GET /payment/bank-transactions/refund-recoveries
List all refund recovery bank transactions
- RefundRecoveryBankTransactionsService
* getPaymentBankTransactionsRefundRecoveriesId
GET /payment/bank-transactions/refund-recoveries/{id}
Retrieve a refund recovery bank transaction
- RefundRecoveryBankTransactionsService
* getPaymentBankTransactionsRefundRecoveriesSearch
GET /payment/bank-transactions/refund-recoveries/search
Search refund recovery bank transactions
- RefundsService
* getPaymentRefunds
GET /payment/refunds
List all refunds
- RefundsService
* getPaymentRefundsId
GET /payment/refunds/{id}
Retrieve a refund
- RefundsService
* getPaymentRefundsIdDocument
GET /payment/refunds/{id}/document
Retrieve a refund document
- RefundsService
* getPaymentRefundsSearch
GET /payment/refunds/search
Search refunds
- RefundsService
* postPaymentRefunds
POST /payment/refunds
Create a refund
- RefundsService
* postPaymentRefundsIdMarkFailed
POST /payment/refunds/{id}/mark-failed
Mark a refund as failed
- RefundsService
* postPaymentRefundsIdMarkSucceeded
POST /payment/refunds/{id}/mark-succeeded
Mark a refund as successful
- RolesService
* deleteRolesId
DELETE /roles/{id}
Delete a role
- RolesService
* getRoles
GET /roles
List all roles
- RolesService
* getRolesId
GET /roles/{id}
Retrieve a role
- RolesService
* getRolesSearch
GET /roles/search
Search roles
- RolesService
* patchRolesId
PATCH /roles/{id}
Update a role
- RolesService
* postRoles
POST /roles
Create a role
- SingleSignOnUsersService
* deleteSingleSignOnUsersId
DELETE /single-sign-on-users/{id}
Delete a single sign-on user
- SingleSignOnUsersService
* getSingleSignOnUsers
GET /single-sign-on-users
List all single sign-on users
- SingleSignOnUsersService
* getSingleSignOnUsersId
GET /single-sign-on-users/{id}
Retrieve a single sign-on user
- SingleSignOnUsersService
* getSingleSignOnUsersSearch
GET /single-sign-on-users/search
Search single sign-on users
- SingleSignOnUsersService
* patchSingleSignOnUsersId
PATCH /single-sign-on-users/{id}
Update a single sign-on user
- SingleSignOnUsersService
* postSingleSignOnUsers
POST /single-sign-on-users
Create a single sign-on user
- SingleSignOnUsersRolesService
* deleteSingleSignOnUsersUserIdAccountRoles
DELETE /single-sign-on-users/{userId}/account-roles
Unassign a role from a single sign-on user for an account
- SingleSignOnUsersRolesService
* deleteSingleSignOnUsersUserIdSpaceRoles
DELETE /single-sign-on-users/{userId}/space-roles
Unassign a role from a single sign-on user for a space
- SingleSignOnUsersRolesService
* getSingleSignOnUsersUserIdAccountRoles
GET /single-sign-on-users/{userId}/account-roles
List all roles of a single sign-on user for an account
- SingleSignOnUsersRolesService
* getSingleSignOnUsersUserIdSpaceRoles
GET /single-sign-on-users/{userId}/space-roles
List all roles of a single sign-on user for a space
- SingleSignOnUsersRolesService
* postSingleSignOnUsersUserIdAccountRoles
POST /single-sign-on-users/{userId}/account-roles
Assign a role to a single sign-on user for an account
- SingleSignOnUsersRolesService
* postSingleSignOnUsersUserIdSpaceRoles
POST /single-sign-on-users/{userId}/space-roles
Assign a role to a single sign-on user for a space
- SpacesService
* deleteSpacesId
DELETE /spaces/{id}
Delete a space
- SpacesService
* getSpaces
GET /spaces
List all spaces
- SpacesService
* getSpacesId
GET /spaces/{id}
Retrieve a space
- SpacesService
* getSpacesSearch
GET /spaces/search
Search spaces
- SpacesService
* patchSpacesId
PATCH /spaces/{id}
Update a space
- SpacesService
* postSpaces
POST /spaces
Create a space
- StaticValuesService
* getStaticValues
GET /static-values
List all static values
- StaticValuesService
* getStaticValuesId
GET /static-values/{id}
Retrieve a static value
- StaticValuesService
* getStaticValuesSearch
GET /static-values/search
Search static values
- SubscribersService
* deleteSubscriptionsSubscribersId
DELETE /subscriptions/subscribers/{id}
Delete a subscriber
- SubscribersService
* getSubscriptionsSubscribers
GET /subscriptions/subscribers
List all subscribers
- SubscribersService
* getSubscriptionsSubscribersId
GET /subscriptions/subscribers/{id}
Retrieve a subscriber
- SubscribersService
* getSubscriptionsSubscribersSearch
GET /subscriptions/subscribers/search
Search subscribers
- SubscribersService
* patchSubscriptionsSubscribersId
PATCH /subscriptions/subscribers/{id}
Update a subscriber
- SubscribersService
* postSubscriptionsSubscribers
POST /subscriptions/subscribers
Create a subscriber
- SubscriptionAffiliatesService
* deleteSubscriptionsAffiliatesId
DELETE /subscriptions/affiliates/{id}
Delete an affiliate
- SubscriptionAffiliatesService
* getSubscriptionsAffiliates
GET /subscriptions/affiliates
List all affiliates
- SubscriptionAffiliatesService
* getSubscriptionsAffiliatesId
GET /subscriptions/affiliates/{id}
Retrieve an affiliate
- SubscriptionAffiliatesService
* getSubscriptionsAffiliatesSearch
GET /subscriptions/affiliates/search
Search affiliates
- SubscriptionAffiliatesService
* patchSubscriptionsAffiliatesId
PATCH /subscriptions/affiliates/{id}
Update an affiliate
- SubscriptionAffiliatesService
* postSubscriptionsAffiliates
POST /subscriptions/affiliates
Create an affiliate
- SubscriptionChargesService
* getSubscriptionsCharges
GET /subscriptions/charges
List all charges
- SubscriptionChargesService
* getSubscriptionsChargesId
GET /subscriptions/charges/{id}
Retrieve a charge
- SubscriptionChargesService
* getSubscriptionsChargesSearch
GET /subscriptions/charges/search
Search charges
- SubscriptionChargesService
* postSubscriptionsCharges
POST /subscriptions/charges
Create a charge
- SubscriptionChargesService
* postSubscriptionsChargesIdDiscard
POST /subscriptions/charges/{id}/discard
Discard a charge
- SubscriptionLedgerEntriesService
* getSubscriptionsLedgerEntries
GET /subscriptions/ledger-entries
List all ledger entries
- SubscriptionLedgerEntriesService
* getSubscriptionsLedgerEntriesId
GET /subscriptions/ledger-entries/{id}
Retrieve a ledger entry
- SubscriptionLedgerEntriesService
* getSubscriptionsLedgerEntriesSearch
GET /subscriptions/ledger-entries/search
Search ledger entries
- SubscriptionLedgerEntriesService
* postSubscriptionsLedgerEntries
POST /subscriptions/ledger-entries
Create a ledger entry
- SubscriptionMetricUsageReportsService
* getSubscriptionsMetricUsageReports
GET /subscriptions/metric-usage-reports
List all metric usage reports
- SubscriptionMetricUsageReportsService
* getSubscriptionsMetricUsageReportsId
GET /subscriptions/metric-usage-reports/{id}
Retrieve a metric usage report
- SubscriptionMetricUsageReportsService
* getSubscriptionsMetricUsageReportsSearch
GET /subscriptions/metric-usage-reports/search
Search metric usage reports
- SubscriptionMetricUsageReportsService
* postSubscriptionsMetricUsageReports
POST /subscriptions/metric-usage-reports
Create a metric usage report
- SubscriptionMetricsService
* deleteSubscriptionsMetricsId
DELETE /subscriptions/metrics/{id}
Delete a metric
- SubscriptionMetricsService
* getSubscriptionsMetrics
GET /subscriptions/metrics
List all metrics
- SubscriptionMetricsService
* getSubscriptionsMetricsId
GET /subscriptions/metrics/{id}
Retrieve a metric
- SubscriptionMetricsService
* getSubscriptionsMetricsSearch
GET /subscriptions/metrics/search
Search metrics
- SubscriptionMetricsService
* patchSubscriptionsMetricsId
PATCH /subscriptions/metrics/{id}
Update a metric
- SubscriptionMetricsService
* postSubscriptionsMetrics
POST /subscriptions/metrics
Create a metric
- SubscriptionPeriodBillsService
* getSubscriptionsPeriodBills
GET /subscriptions/period-bills
List all subscription period bills
- SubscriptionPeriodBillsService
* getSubscriptionsPeriodBillsId
GET /subscriptions/period-bills/{id}
Retrieve a subscription period bill
- SubscriptionPeriodBillsService
* getSubscriptionsPeriodBillsSearch
GET /subscriptions/period-bills/search
Search subscription period bills
- SubscriptionPeriodBillsService
* postSubscriptionsPeriodBillsIdClose
POST /subscriptions/period-bills/{id}/close
Close a subscription period bill
- SubscriptionProductComponentGroupsService
* deleteSubscriptionsProductsComponentGroupsId
DELETE /subscriptions/products/component-groups/{id}
Delete a component group
- SubscriptionProductComponentGroupsService
* getSubscriptionsProductsComponentGroups
GET /subscriptions/products/component-groups
List all component groups
- SubscriptionProductComponentGroupsService
* getSubscriptionsProductsComponentGroupsId
GET /subscriptions/products/component-groups/{id}
Retrieve a component group
- SubscriptionProductComponentGroupsService
* getSubscriptionsProductsComponentGroupsSearch
GET /subscriptions/products/component-groups/search
Search component groups
- SubscriptionProductComponentGroupsService
* patchSubscriptionsProductsComponentGroupsId
PATCH /subscriptions/products/component-groups/{id}
Update a component group
- SubscriptionProductComponentGroupsService
* postSubscriptionsProductsComponentGroups
POST /subscriptions/products/component-groups
Create a component group
- SubscriptionProductComponentsService
* deleteSubscriptionsProductsComponentsId
DELETE /subscriptions/products/components/{id}
Delete a component
- SubscriptionProductComponentsService
* getSubscriptionsProductsComponents
GET /subscriptions/products/components
List all components
- SubscriptionProductComponentsService
* getSubscriptionsProductsComponentsId
GET /subscriptions/products/components/{id}
Retrieve a component
- SubscriptionProductComponentsService
* getSubscriptionsProductsComponentsSearch
GET /subscriptions/products/components/search
Search components
- SubscriptionProductComponentsService
* patchSubscriptionsProductsComponentsId
PATCH /subscriptions/products/components/{id}
Update a component
- SubscriptionProductComponentsService
* postSubscriptionsProductsComponents
POST /subscriptions/products/components
Create a component
- SubscriptionProductMeteredFeeTiersService
* deleteSubscriptionsProductsMeteredFeesFeeIdTiersId
DELETE /subscriptions/products/metered-fees/{feeId}/tiers/{id}
Delete a metered fee tier
- SubscriptionProductMeteredFeeTiersService
* getSubscriptionsProductsMeteredFeesFeeIdTiers
GET /subscriptions/products/metered-fees/{feeId}/tiers
List all metered fee tiers
- SubscriptionProductMeteredFeeTiersService
* getSubscriptionsProductsMeteredFeesFeeIdTiersId
GET /subscriptions/products/metered-fees/{feeId}/tiers/{id}
Retrieve a metered fee tier
- SubscriptionProductMeteredFeeTiersService
* getSubscriptionsProductsMeteredFeesFeeIdTiersSearch
GET /subscriptions/products/metered-fees/{feeId}/tiers/search
Search metered fee tiers
- SubscriptionProductMeteredFeeTiersService
* patchSubscriptionsProductsMeteredFeesFeeIdTiersId
PATCH /subscriptions/products/metered-fees/{feeId}/tiers/{id}
Update a metered fee tier
- SubscriptionProductMeteredFeeTiersService
* postSubscriptionsProductsMeteredFeesFeeIdTiers
POST /subscriptions/products/metered-fees/{feeId}/tiers
Create a metered fee tier
- SubscriptionProductMeteredFeesService
* deleteSubscriptionsProductsMeteredFeesId
DELETE /subscriptions/products/metered-fees/{id}
Delete a metered fee
- SubscriptionProductMeteredFeesService
* getSubscriptionsProductsMeteredFees
GET /subscriptions/products/metered-fees
List all metered fees
- SubscriptionProductMeteredFeesService
* getSubscriptionsProductsMeteredFeesId
GET /subscriptions/products/metered-fees/{id}
Retrieve a metered fee
- SubscriptionProductMeteredFeesService
* getSubscriptionsProductsMeteredFeesSearch
GET /subscriptions/products/metered-fees/search
Search metered fees
- SubscriptionProductMeteredFeesService
* patchSubscriptionsProductsMeteredFeesId
PATCH /subscriptions/products/metered-fees/{id}
Update a metered fee
- SubscriptionProductMeteredFeesService
* postSubscriptionsProductsMeteredFees
POST /subscriptions/products/metered-fees
Create a metered fee
- SubscriptionProductPeriodFeesService
* deleteSubscriptionsProductsPeriodFeesId
DELETE /subscriptions/products/period-fees/{id}
Delete a period fee
- SubscriptionProductPeriodFeesService
* getSubscriptionsProductsPeriodFees
GET /subscriptions/products/period-fees
List all period fees
- SubscriptionProductPeriodFeesService
* getSubscriptionsProductsPeriodFeesId
GET /subscriptions/products/period-fees/{id}
Retrieve a period fee
- SubscriptionProductPeriodFeesService
* getSubscriptionsProductsPeriodFeesSearch
GET /subscriptions/products/period-fees/search
Search period fees
- SubscriptionProductPeriodFeesService
* patchSubscriptionsProductsPeriodFeesId
PATCH /subscriptions/products/period-fees/{id}
Update a period fee
- SubscriptionProductPeriodFeesService
* postSubscriptionsProductsPeriodFees
POST /subscriptions/products/period-fees
Create a period fee
- SubscriptionProductRetirementsService
* getSubscriptionsProductsRetirements
GET /subscriptions/products/retirements
List all product retirements
- SubscriptionProductRetirementsService
* getSubscriptionsProductsRetirementsId
GET /subscriptions/products/retirements/{id}
Retrieve a product retirement
- SubscriptionProductRetirementsService
* getSubscriptionsProductsRetirementsSearch
GET /subscriptions/products/retirements/search
Search product retirements
- SubscriptionProductSetupFeesService
* deleteSubscriptionsProductsSetupFeesId
DELETE /subscriptions/products/setup-fees/{id}
Delete a setup fee
- SubscriptionProductSetupFeesService
* getSubscriptionsProductsSetupFees
GET /subscriptions/products/setup-fees
List all setup fees
- SubscriptionProductSetupFeesService
* getSubscriptionsProductsSetupFeesId
GET /subscriptions/products/setup-fees/{id}
Retrieve a setup fee
- SubscriptionProductSetupFeesService
* getSubscriptionsProductsSetupFeesSearch
GET /subscriptions/products/setup-fees/search
Search setup fees
- SubscriptionProductSetupFeesService
* patchSubscriptionsProductsSetupFeesId
PATCH /subscriptions/products/setup-fees/{id}
Update a setup fee
- SubscriptionProductSetupFeesService
* postSubscriptionsProductsSetupFees
POST /subscriptions/products/setup-fees
Create a setup fee
- SubscriptionProductVersionRetirementsService
* getSubscriptionsProductsVersionsRetirements
GET /subscriptions/products/versions/retirements
List all product version retirements
- SubscriptionProductVersionRetirementsService
* getSubscriptionsProductsVersionsRetirementsId
GET /subscriptions/products/versions/retirements/{id}
Retrieve a product version retirement
- SubscriptionProductVersionRetirementsService
* getSubscriptionsProductsVersionsRetirementsSearch
GET /subscriptions/products/versions/retirements/search
Search product version retirements
- SubscriptionProductVersionsService
* getSubscriptionsProductsVersions
GET /subscriptions/products/versions
List all product versions
- SubscriptionProductVersionsService
* getSubscriptionsProductsVersionsId
GET /subscriptions/products/versions/{id}
Retrieve a product version
- SubscriptionProductVersionsService
* getSubscriptionsProductsVersionsSearch
GET /subscriptions/products/versions/search
Search product versions
- SubscriptionProductVersionsService
* patchSubscriptionsProductsVersionsId
PATCH /subscriptions/products/versions/{id}
Update a product version
- SubscriptionProductVersionsService
* postSubscriptionsProductsVersions
POST /subscriptions/products/versions
Create a product version
- SubscriptionProductVersionsService
* postSubscriptionsProductsVersionsIdActivate
POST /subscriptions/products/versions/{id}/activate
Activate a product version
- SubscriptionProductVersionsService
* postSubscriptionsProductsVersionsIdRetire
POST /subscriptions/products/versions/{id}/retire
Retire a product version
- SubscriptionProductsService
* getSubscriptionsProducts
GET /subscriptions/products
List all products
- SubscriptionProductsService
* getSubscriptionsProductsId
GET /subscriptions/products/{id}
Retrieve a product
- SubscriptionProductsService
* getSubscriptionsProductsSearch
GET /subscriptions/products/search
Search products
- SubscriptionProductsService
* patchSubscriptionsProductsId
PATCH /subscriptions/products/{id}
Update a product
- SubscriptionProductsService
* postSubscriptionsProducts
POST /subscriptions/products
Create a product
- SubscriptionProductsService
* postSubscriptionsProductsIdRetire
POST /subscriptions/products/{id}/retire
Retire a product
- SubscriptionSuspensionsService
* getSubscriptionsSuspensions
GET /subscriptions/suspensions
List all suspensions
- SubscriptionSuspensionsService
* getSubscriptionsSuspensionsId
GET /subscriptions/suspensions/{id}
Retrieve a suspension
- SubscriptionSuspensionsService
* getSubscriptionsSuspensionsSearch
GET /subscriptions/suspensions/search
Search suspensions
- SubscriptionVersionsService
* getSubscriptionsVersions
GET /subscriptions/versions
List all subscription versions
- SubscriptionVersionsService
* getSubscriptionsVersionsId
GET /subscriptions/versions/{id}
Retrieve a subscription version
- SubscriptionVersionsService
* getSubscriptionsVersionsSearch
GET /subscriptions/versions/search
Search subscription versions
- SubscriptionsService
* getSubscriptions
GET /subscriptions
List all subscriptions
- SubscriptionsService
* getSubscriptionsId
GET /subscriptions/{id}
Retrieve a subscription
- SubscriptionsService
* getSubscriptionsIdInvoices
GET /subscriptions/{id}/invoices
Search subscription invoices
- SubscriptionsService
* getSubscriptionsSearch
GET /subscriptions/search
Search subscriptions
- SubscriptionsService
* patchSubscriptionsId
PATCH /subscriptions/{id}
Update a subscription
- SubscriptionsService
* postSubscriptions
POST /subscriptions
Create a subscription
- SubscriptionsService
* postSubscriptionsIdApplyChanges
POST /subscriptions/{id}/apply-changes
Apply changes to a subscription
- SubscriptionsService
* postSubscriptionsIdInitialize
POST /subscriptions/{id}/initialize
Initialize a subscription
- SubscriptionsService
* postSubscriptionsIdInitializeSubscriberPresent
POST /subscriptions/{id}/initialize-subscriber-present
Initialize a subscription with the subscriber present
- SubscriptionsService
* postSubscriptionsIdReactivate
POST /subscriptions/{id}/reactivate
Reactivate a suspended subscription
- SubscriptionsService
* postSubscriptionsIdSuspend
POST /subscriptions/{id}/suspend