Saltar para o conteúdo
/
Obter Produtos

Subscriptions API (2.0)

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 e o glossário.

Transferir a descrição da OpenAPI
index.json
index.yaml
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/pt/api/subscriptions/

Token

Operações

Planos

Operações

Produtos

Operações

Obter Produtos

Pedido

Lista todos os produtos com base em assinaturas.

Segurança
basicAuth
Caminho
project_idintegerobrigatório

ID de projeto.

Consulta
offsetinteger

Número do elemento a partir do qual a lista é gerada (a quantidade começa a partir de 0).

limitintegerobrigatório

Limite da quantidade de elementos na página.

group_idstring

ID de grupo aos quais os planos estão vinculados.

product_idinteger

ID de produto aos quais os planos estão vinculados.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/subscriptions/projects/{project_id}/subscriptions/products?offset=0&limit=0&group_id=string&product_id=0'

Respostas

OK.

Corpoapplication/jsonArray [
idinteger or null

ID de produto aos quais os planos estão vinculados.

descriptionobject

Descrições de itens traduzidas.

group_idstring

ID de grupo ao qual o produto está vinculado.

namestring

Nome do produto.

]
Resposta
application/json
[
  {
    "description": { … },
    "group_id": "charge",
    "id": 714,
    "name": "Channel"
  },
  {
    "description": { … },
    "group_id": "notify",
    "id": 715,
    "name": "notify"
  },
  {
    "description": { … },
    "group_id": "charge",
    "id": 716,
    "name": "charge2"
  },
  {
    "description": { … },
    "group_id": "charge",
    "id": 486,
    "name": "Channel2"
  }
]

Criar Produto

Pedido

Cria um produto com base em assinaturas.

Segurança
basicAuth
Caminho
project_idintegerobrigatório

ID de projeto.

Corpoapplication/jsonobrigatório
descriptionobject

Descrições de itens traduzidas.

group_idstringobrigatório

ID de grupo ao qual o produto está vinculado.

namestringobrigatório

Nome do produto.

curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/subscriptions/projects/{project_id}/subscriptions/products' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": {
      "en": "Kids TV"
    },
    "group_id": "charge",
    "name": "Channel2"
  }'

Respostas

Criado.

Corpoapplication/json
product_idinteger
Resposta
application/json
{
  "product_id": 172003
}

Excluir Produto

Pedido

Exclui um produto com base em assinaturas.

Segurança
basicAuth
Caminho
project_idintegerobrigatório

ID de projeto.

product_idintegerobrigatório

ID de produto aos quais os planos estão vinculados.

curl -i -X DELETE \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/subscriptions/projects/{project_id}/subscriptions/products/{product_id}'

Respostas

Nenhum conteúdo.

Subscription management

Operações

Pagamentos

Operações

Promoções

Operações

Cupons

Operações

Subscription management

Operações