# Subscriptions API # Visão geral * **Versão:** 2.0 * **Servidores**: `https://api.xsolla.com/merchant/v2/` Essa referência API descreve os pontos de extremidade na gerência de assinaturas, cupons e promoções. Para obter mais informações sobre as Assinaturas, veja o [guia do produto](https://developers.xsolla.com/pt/doc/subscriptions) e o [glossário](https://developers.xsolla.com/pt/doc/subscriptions/integration-guide/get-started/#general_glossary). Version: 2.0 ## Security ### basicAuth O Xsolla API utiliza autenticações de acesso básica. Todas as solicitações ao API devem conter o cabeçalho `Authorization: Basic `, onde `` é o par `merchant_id:api_key` codificado de acordo com o padrão Base64. Vá para a [Conta de Distribuidor](https://publisher.xsolla.com/) para encontrar esses parâmetros:
Para saber mais sobre como trabalhar com as chaves API, veja a [referência API](https://developers.xsolla.com/pt/api/getting-started/#api_keys_overview). Type: http Scheme: basic ### subscriptionsManagementJwtAuth Type: http Scheme: bearer ## Download OpenAPI description [Subscriptions API](https://developers.xsolla.com/_bundle/@l10n/pt/api/subscriptions/index.yaml) ## Token ### Criar token - [POST /merchants/{merchant_id}/token](https://developers.xsolla.com/pt/api/subscriptions/token/create-token.md): Você pode criar um token com parâmetros de usuário arbitrários. Você envia esses parâmetros ao obter o token e os recebe de volta após um pagamento bem-sucedido. Um token só pode conter parâmetros descritos neste documento ou predefinidos por você. Se algum parâmetro for enviado no formato errado ou tiver o tipo errado, nenhum token será emitido. Você receberá um código HTTP 422 com a descrição do erro no corpo JSON. Em extended_message você receberá uma informação sobre quais parâmetros exatos foram enviados incorretamente. AvisoEsta chamada de API não contém o trajeto-parâmetro project_id, então é preciso usar a chave API que for válida em todos os projetos da empresa para configurar a autorização. ## Planos ### Obter Planos - [GET /projects/{project_id}/subscriptions/plans](https://developers.xsolla.com/pt/api/subscriptions/plans/get-plans.md): Lista todos os planos de assinaturas. ### Criar Plano - [POST /projects/{project_id}/subscriptions/plans](https://developers.xsolla.com/pt/api/subscriptions/plans/create-plan.md): Crie um plano de assinatura. ### Desativar Plano - [DELETE /projects/{project_id}/subscriptions/plans/{plan_id}](https://developers.xsolla.com/pt/api/subscriptions/plans/disable-plan.md): Desativa um plano de assinatura. ### Ativar Plano - [PATCH /projects/{project_id}/subscriptions/plans/{plan_id}](https://developers.xsolla.com/pt/api/subscriptions/plans/enable-plan.md): Ative um plano de assinatura. ### Atualizar Plano - [PUT /projects/{project_id}/subscriptions/plans/{plan_id}](https://developers.xsolla.com/pt/api/subscriptions/plans/update-plan-parameters.md): Atualiza os parâmetros do plano de assinatura. ### Excluir Plano - [DELETE /projects/{project_id}/subscriptions/plans/{plan_id}/delete](https://developers.xsolla.com/pt/api/subscriptions/plans/delete-plan.md): Exclui um plano de assinatura. ## Produtos ### Obter Produtos - [GET /projects/{project_id}/subscriptions/products](https://developers.xsolla.com/pt/api/subscriptions/products/get-products.md): Lista todos os produtos com base em assinaturas. ### Criar Produto - [POST /projects/{project_id}/subscriptions/products](https://developers.xsolla.com/pt/api/subscriptions/products/create-product.md): Cria um produto com base em assinaturas. ### Excluir Produto - [DELETE /projects/{project_id}/subscriptions/products/{product_id}](https://developers.xsolla.com/pt/api/subscriptions/products/delete-product.md): Exclui um produto com base em assinaturas. ### Atualizar Produto - [PUT /projects/{project_id}/subscriptions/products/{product_id}](https://developers.xsolla.com/pt/api/subscriptions/products/update-product.md): Atualiza um produto com base em assinaturas. ## Subscription management ### Obter Assinaturas - [GET /merchants/{merchant_id}/subscriptions](https://developers.xsolla.com/pt/api/subscriptions/subscriptions/get-subscriptions.md): Lists all recurrent subscriptions.AvisoEste método de API não pode ser usado sob uma carga alta. A carga máxima é de 20 solicitações por minuto. AvisoEsta chamada de API não contém o trajeto-parâmetro project_id, então é preciso usar a chave API que for válida em todos os projetos da empresa para configurar a autorização. ### Obter Assinatura - [GET /projects/{project_id}/subscriptions/{subscription_id}](https://developers.xsolla.com/pt/api/subscriptions/subscriptions/get-subscription.md): Obtém os dados específicos de uma assinatura por ID. ### Atualizar Assinatura - [PUT /projects/{project_id}/users/{user_id}/subscriptions/{subscription_id}](https://developers.xsolla.com/pt/api/subscriptions/subscriptions/update-subscription.md): Atualiza uma assinatura alterando seu status (active, canceled, ou non_renewing) ou atrasando a próxima data de cobrança. ## Pagamentos ### Obter Moedas - [GET /projects/{project_id}/subscriptions/currencies](https://developers.xsolla.com/pt/api/subscriptions/payments/get-currencies.md): Lista todas as moedas de assinatura suportadas. ### Obter Pagamentos - [GET /projects/{project_id}/subscriptions/payments](https://developers.xsolla.com/pt/api/subscriptions/payments/get-payments.md): Lista todos os pagamentos de assinaturas. ### Obter Pagamentos de Usuário - [GET /projects/{project_id}/users/{user_id}/subscriptions/payments](https://developers.xsolla.com/pt/api/subscriptions/payments/get-user-payments.md): Lista todos os pagamentos feitos por um usuário específico. ## Promoções ### Obter Lista de Promoções - [GET /merchants/{merchant_id}/promotions](https://developers.xsolla.com/pt/api/subscriptions/promotions/get-promotions-list.md): Lista de todas as promoções. AvisoEsta chamada de API não contém o trajeto-parâmetro project_id, então é preciso usar a chave API que for válida em todos os projetos da empresa para configurar a autorização. ### Criar Promoção - [POST /merchants/{merchant_id}/promotions](https://developers.xsolla.com/pt/api/subscriptions/promotions/create-promotion.md): Crie uma nova promoção. AvisoEsta chamada de API não contém o trajeto-parâmetro project_id, então é preciso usar a chave API que for válida em todos os projetos da empresa para configurar a autorização. ### Excluir Promoção - [DELETE /merchants/{merchant_id}/promotions/{promotion_id}](https://developers.xsolla.com/pt/api/subscriptions/promotions/delete-promotion.md): Exclui uma promoção. Você só pode excluir promoções com enabled = false. AvisoEsta chamada de API não contém o trajeto-parâmetro project_id, então é preciso usar a chave API que for válida em todos os projetos da empresa para configurar a autorização. ### Obter Promoção - [GET /merchants/{merchant_id}/promotions/{promotion_id}](https://developers.xsolla.com/pt/api/subscriptions/promotions/get-promotion.md): Recupera uma promoção. AvisoEsta chamada de API não contém o trajeto-parâmetro project_id, então é preciso usar a chave API que for válida em todos os projetos da empresa para configurar a autorização. ### Atualizar Promoção - [PUT /merchants/{merchant_id}/promotions/{promotion_id}](https://developers.xsolla.com/pt/api/subscriptions/promotions/update-promotion.md): Atualiza uma promoção. Se a promoção for somente leitura (read_only = true), você não tem permissão para alterar o parâmetro project_id. AvisoEsta chamada de API não contém o trajeto-parâmetro project_id, então é preciso usar a chave API que for válida em todos os projetos da empresa para configurar a autorização. ### Obter Sistemas de Pagamento - [GET /merchants/{merchant_id}/promotions/{promotion_id}/payment_systems](https://developers.xsolla.com/pt/api/subscriptions/promotions/get-payment-systems.md): Obtém sistemas de pagamento suportados para uma promoção. Se a lista estiver vazia, a promoção será aplicada a todos os sistemas de pagamento. AvisoEsta chamada de API não contém o trajeto-parâmetro project_id, então é preciso usar a chave API que for válida em todos os projetos da empresa para configurar a autorização. ### Definir Sistemas de Pagamento - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/payment_systems](https://developers.xsolla.com/pt/api/subscriptions/promotions/set-payment-systems.md): Define os sistemas de pagamento suportados para uma promoção. Se a lista estiver vazia, a promoção será aplicada a todos os sistemas de pagamento. Se a promoção for somente leitura (read_only = true), você não poderá chamar este método. AvisoEsta chamada de API não contém o trajeto-parâmetro project_id, então é preciso usar a chave API que for válida em todos os projetos da empresa para configurar a autorização. ### Obter Períodos Válidos - [GET /merchants/{merchant_id}/promotions/{promotion_id}/periods](https://developers.xsolla.com/pt/api/subscriptions/promotions/get-validity-periods.md): Obtém intervalos de data/hora em que uma promoção é válida. AvisoEsta chamada de API não contém o trajeto-parâmetro project_id, então é preciso usar a chave API que for válida em todos os projetos da empresa para configurar a autorização. ### Definir Períodos de Validade - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/periods](https://developers.xsolla.com/pt/api/subscriptions/promotions/set-validity-periods.md): Define intervalos de data/hora quando uma promoção é válida. Se a promoção for somente leitura (read_only = true), você não poderá editar períodos existentes, mas poderá adicionar novos. AvisoEsta chamada de API não contém o trajeto-parâmetro project_id, então é preciso usar a chave API que for válida em todos os projetos da empresa para configurar a autorização. ### Revisar Promoção - [GET /merchants/{merchant_id}/promotions/{promotion_id}/review](https://developers.xsolla.com/pt/api/subscriptions/promotions/review-promotion.md): Você precisa revisar uma promoção antes de ativá-la. Este método retorna a lista de erros, se houver. AvisoEsta chamada de API não contém o trajeto-parâmetro project_id, então é preciso usar a chave API que for válida em todos os projetos da empresa para configurar a autorização. ### Obter Recompensas - [GET /merchants/{merchant_id}/promotions/{promotion_id}/rewards](https://developers.xsolla.com/pt/api/subscriptions/promotions/get-rewards.md): Obtém a lista de recompensas associadas a uma promoção. AvisoEsta chamada de API não contém o trajeto-parâmetro project_id, então é preciso usar a chave API que for válida em todos os projetos da empresa para configurar a autorização. ### Definir Recompensas - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/rewards](https://developers.xsolla.com/pt/api/subscriptions/promotions/set-rewards.md): Define as recompensas para uma promoção. Se a promoção for somente leitura (read_only = true), você não poderá atualizar as recompensas. AvisoEsta chamada de API não contém o trajeto-parâmetro project_id, então é preciso usar a chave API que for válida em todos os projetos da empresa para configurar a autorização. ### Obter Assunto - [GET /merchants/{merchant_id}/promotions/{promotion_id}/subject](https://developers.xsolla.com/pt/api/subscriptions/promotions/get-subject.md): Obtém informações sobre o assunto de uma promoção. AvisoEsta chamada de API não contém o trajeto-parâmetro project_id, então é preciso usar a chave API que for válida em todos os projetos da empresa para configurar a autorização. ### Definir Assunto - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/subject](https://developers.xsolla.com/pt/api/subscriptions/promotions/set-subject.md): Define o assunto de uma promoção. Se a promoção for somente leitura (read_only = true), você não poderá atualizar o assunto. O assunto pode assumir os seguintes valores: purchase, ou items, ou packages. AvisoEsta chamada de API não contém o trajeto-parâmetro project_id, então é preciso usar a chave API que for válida em todos os projetos da empresa para configurar a autorização. ### Alternar Promoção - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/toggle](https://developers.xsolla.com/pt/api/subscriptions/promotions/toggle-promotion.md): Alterna o status de uma promoção de enabledpara disabled e vice-versa. AvisoEsta chamada de API não contém o trajeto-parâmetro project_id, então é preciso usar a chave API que for válida em todos os projetos da empresa para configurar a autorização. ## Cupons ### Criar Campanha - [POST /merchants/{merchant_id}/coupon_promotions](https://developers.xsolla.com/pt/api/subscriptions/coupons/create-campaign.md): Você precisa revisar uma promoção antes de ativá-la. Este método retorna a lista de erros, se houver. AvisoEsta chamada de API não contém o trajeto-parâmetro project_id, então é preciso usar a chave API que for válida em todos os projetos da empresa para configurar a autorização. ### Adicionar Cupom à Campanha - [POST /merchants/{merchant_id}/coupon_promotions/{campaign_id}/coupons](https://developers.xsolla.com/pt/api/subscriptions/coupons/add-coupon-to-campaign.md): Adicione um código de cupom a uma campanha de cupom. AvisoEsta chamada de API não contém o trajeto-parâmetro project_id, então é preciso usar a chave API que for válida em todos os projetos da empresa para configurar a autorização. ### Anexar Campanha à Promoção - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/coupons](https://developers.xsolla.com/pt/api/subscriptions/coupons/attach-campaign-to-promotion.md): Anexe uma campanha de cupom a uma promoção específica. AvisoEsta chamada de API não contém o trajeto-parâmetro project_id, então é preciso usar a chave API que for válida em todos os projetos da empresa para configurar a autorização. ### Obet Cupom - [GET /projects/{project_id}/coupons/{code}/details](https://developers.xsolla.com/pt/api/subscriptions/coupons/get-coupon.md): Obter dados do cupom com o código dele. ### Resgatar Cupom - [POST /projects/{project_id}/coupons/{code}/redeem](https://developers.xsolla.com/pt/api/subscriptions/coupons/redeem-coupon.md): Resgate um cupom com o código dele. ## Subscription management ### List subscriptions - [GET /api/user/v1/management/projects/{project_id}/subscriptions](https://developers.xsolla.com/pt/api/subscriptions/subscription-management/list-subscriptions.md) ### Get management settings - [GET /api/user/v1/management/projects/{project_id}/subscriptions/settings](https://developers.xsolla.com/pt/api/subscriptions/subscription-management/get-management-settings.md) ### Get subscription - [GET /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}](https://developers.xsolla.com/pt/api/subscriptions/subscription-management/get-management-subscription.md) ### Activate subscription - [PUT /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/activate](https://developers.xsolla.com/pt/api/subscriptions/subscription-management/activate-subscription.md) ### Cancel subscription - [PUT /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/cancel](https://developers.xsolla.com/pt/api/subscriptions/subscription-management/cancel-subscription.md) ### Get change plan link - [POST /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/change_plan](https://developers.xsolla.com/pt/api/subscriptions/subscription-management/get-change-plan-link.md) ### Get payment account - [GET /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/payment_account](https://developers.xsolla.com/pt/api/subscriptions/subscription-management/get-payment-account.md) ### Manage payment account - [POST /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/payment_account/manage](https://developers.xsolla.com/pt/api/subscriptions/subscription-management/manage-payment-account.md) ### List payment accounts - [GET /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/payment_accounts](https://developers.xsolla.com/pt/api/subscriptions/subscription-management/list-payment-accounts.md) ### Link payment account - [POST /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/payment_accounts](https://developers.xsolla.com/pt/api/subscriptions/subscription-management/link-payment-account.md) ### Unlink payment account - [DELETE /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/payment_accounts/{payment_account_id}](https://developers.xsolla.com/pt/api/subscriptions/subscription-management/unlink-payment-account.md) ### List plans for change - [GET /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/plans_for_change](https://developers.xsolla.com/pt/api/subscriptions/subscription-management/list-plans-for-change.md) ### Get plan for change - [GET /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/plans_for_change/{plan_id}](https://developers.xsolla.com/pt/api/subscriptions/subscription-management/get-plan-for-change.md)