Saltar para o conteúdo
/
Get catalog

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

Assinaturas

Operações

Pagamentos

Operações

Promoções

Operações

Cupons

Operações

Assinaturas

Operações

Catalog

Operações

List plans (no auth)

Pedido

Caminho
project_idinteger\d+obrigatório
Consulta
plan_idArray of integers
plan_external_idArray of strings
limitinteger
offsetinteger
localestring
countrystring
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/pt/api/subscriptions/api/public/v1/projects/{project_id}/user_plans?plan_id=0&plan_external_id=string&limit=0&offset=0&locale=string&country=string'

Respostas

Subscription's default plans

Corpoapplication/json
has_morebooleanobrigatório
Exemplo: "false"
itemsArray of objects
Padrão []
items[].​chargeobjectobrigatório
items[].​charge.​amountnumber(float)obrigatório
Exemplo: 4.99
items[].​charge.​currencystringobrigatório
Exemplo: "USD"
items[].​charge.​setup_feenumber(float)obrigatório
Exemplo: 0.99
items[].​periodobjectobrigatório
items[].​period.​unitstring or null
Padrão null
Exemplo: "month"
items[].​period.​valueinteger or null
Padrão null
Exemplo: "1"
items[].​plan_descriptionstringobrigatório
Exemplo: "Localized plan description"
items[].​plan_end_datestring or null(date-time)
Exemplo: "2031-04-11T13:51:02+03:00"
items[].​plan_external_idstringobrigatório
Exemplo: "PlanExternalId"
items[].​plan_group_idstring or null
Exemplo: "TestGroupId"
items[].​plan_idintegerobrigatório
Exemplo: "54321"
items[].​plan_namestringobrigatório
Exemplo: "Localized plan name"
items[].​plan_start_datestring or null(date-time)
Exemplo: "2021-04-11T13:51:02+03:00"
items[].​plan_typestringobrigatório
Exemplo: "all"
items[].​promotionobjectobrigatório
items[].​promotion.​promotion_charge_amountnumber or null(float)
Padrão null
Exemplo: "3.99"
items[].​promotion.​promotion_remaining_chargesinteger or null
Padrão null
Exemplo: "3"
items[].​trial_periodinteger or null
Exemplo: "7"
Resposta
application/json
{
  "has_more": "false",
  "items": []
}

Get catalog

Pedido

Segurança
projectUserJwtAuth
Caminho
project_idinteger\d+obrigatório
Consulta
limitinteger
offsetinteger
localestring
countrystring
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/pt/api/subscriptions/api/user/v1/projects/{project_id}/catalog?limit=0&offset=0&locale=string&country=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Respostas

Subscription's catalog

Corpoapplication/json
default_plansobjectobrigatório
default_plans.​has_morebooleanobrigatório
Exemplo: "false"
default_plans.​itemsArray of objects
Padrão []
default_plans.​items[].​chargeobjectobrigatório
default_plans.​items[].​charge.​amountnumber(float)obrigatório
Exemplo: 4.99
default_plans.​items[].​charge.​currencystringobrigatório
Exemplo: "USD"
default_plans.​items[].​charge.​setup_feenumber(float)obrigatório
Exemplo: 0.99
default_plans.​items[].​periodobjectobrigatório
default_plans.​items[].​period.​unitstring or null
Padrão null
Exemplo: "month"
default_plans.​items[].​period.​valueinteger or null
Padrão null
Exemplo: "1"
default_plans.​items[].​plan_descriptionstringobrigatório
Exemplo: "Localized plan description"
default_plans.​items[].​plan_end_datestring or null(date-time)
Exemplo: "2031-04-11T13:51:02+03:00"
default_plans.​items[].​plan_external_idstringobrigatório
Exemplo: "PlanExternalId"
default_plans.​items[].​plan_group_idstring or null
Exemplo: "TestGroupId"
default_plans.​items[].​plan_idintegerobrigatório
Exemplo: "54321"
default_plans.​items[].​plan_namestringobrigatório
Exemplo: "Localized plan name"
default_plans.​items[].​plan_start_datestring or null(date-time)
Exemplo: "2021-04-11T13:51:02+03:00"
default_plans.​items[].​plan_typestringobrigatório
Exemplo: "all"
default_plans.​items[].​promotionobjectobrigatório
default_plans.​items[].​promotion.​promotion_charge_amountnumber or null(float)
Padrão null
Exemplo: "3.99"
default_plans.​items[].​promotion.​promotion_remaining_chargesinteger or null
Padrão null
Exemplo: "3"
default_plans.​items[].​trial_periodinteger or null
Exemplo: "7"
default_plans.​namestring or null
Exemplo: "Some product name"
has_morebooleanobrigatório
Exemplo: "false"
plans_by_productArray of objects
Padrão []
plans_by_product[].​has_morebooleanobrigatório
Exemplo: "false"
plans_by_product[].​itemsArray of objects
Padrão []
plans_by_product[].​items[].​chargeobjectobrigatório
plans_by_product[].​items[].​charge.​amountnumber(float)obrigatório
Exemplo: 4.99
plans_by_product[].​items[].​charge.​currencystringobrigatório
Exemplo: "USD"
plans_by_product[].​items[].​charge.​setup_feenumber(float)obrigatório
Exemplo: 0.99
plans_by_product[].​items[].​periodobjectobrigatório
plans_by_product[].​items[].​period.​unitstring or null
Padrão null
Exemplo: "month"
plans_by_product[].​items[].​period.​valueinteger or null
Padrão null
Exemplo: "1"
plans_by_product[].​items[].​plan_descriptionstringobrigatório
Exemplo: "Localized plan description"
plans_by_product[].​items[].​plan_end_datestring or null(date-time)
Exemplo: "2031-04-11T13:51:02+03:00"
plans_by_product[].​items[].​plan_external_idstringobrigatório
Exemplo: "PlanExternalId"
plans_by_product[].​items[].​plan_group_idstring or null
Exemplo: "TestGroupId"
plans_by_product[].​items[].​plan_idintegerobrigatório
Exemplo: "54321"
plans_by_product[].​items[].​plan_namestringobrigatório
Exemplo: "Localized plan name"
plans_by_product[].​items[].​plan_start_datestring or null(date-time)
Exemplo: "2021-04-11T13:51:02+03:00"
plans_by_product[].​items[].​plan_typestringobrigatório
Exemplo: "all"
plans_by_product[].​items[].​promotionobjectobrigatório
plans_by_product[].​items[].​promotion.​promotion_charge_amountnumber or null(float)
Padrão null
Exemplo: "3.99"
plans_by_product[].​items[].​promotion.​promotion_remaining_chargesinteger or null
Padrão null
Exemplo: "3"
plans_by_product[].​items[].​trial_periodinteger or null
Exemplo: "7"
plans_by_product[].​namestring or null
Exemplo: "Some product name"
Resposta
application/json
{
  "default_plans": {
    "has_more": "false",
    "items": [],
    "name": "Some product name"
  },
  "has_more": "false",
  "plans_by_product": []
}

List plans

Pedido

Segurança
projectUserJwtAuth
Caminho
project_idinteger\d+obrigatório
Consulta
plan_idArray of integers
plan_external_idArray of strings
limitinteger
offsetinteger
localestring
countrystring
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/pt/api/subscriptions/api/user/v1/projects/{project_id}/plans?plan_id=0&plan_external_id=string&limit=0&offset=0&locale=string&country=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Respostas

Subscription's default plans

Corpoapplication/json
has_morebooleanobrigatório
Exemplo: "false"
itemsArray of objects
Padrão []
items[].​chargeobjectobrigatório
items[].​charge.​amountnumber(float)obrigatório
Exemplo: 4.99
items[].​charge.​currencystringobrigatório
Exemplo: "USD"
items[].​charge.​setup_feenumber(float)obrigatório
Exemplo: 0.99
items[].​periodobjectobrigatório
items[].​period.​unitstring or null
Padrão null
Exemplo: "month"
items[].​period.​valueinteger or null
Padrão null
Exemplo: "1"
items[].​plan_descriptionstringobrigatório
Exemplo: "Localized plan description"
items[].​plan_end_datestring or null(date-time)
Exemplo: "2031-04-11T13:51:02+03:00"
items[].​plan_external_idstringobrigatório
Exemplo: "PlanExternalId"
items[].​plan_group_idstring or null
Exemplo: "TestGroupId"
items[].​plan_idintegerobrigatório
Exemplo: "54321"
items[].​plan_namestringobrigatório
Exemplo: "Localized plan name"
items[].​plan_start_datestring or null(date-time)
Exemplo: "2021-04-11T13:51:02+03:00"
items[].​plan_typestringobrigatório
Exemplo: "all"
items[].​promotionobjectobrigatório
items[].​promotion.​promotion_charge_amountnumber or null(float)
Padrão null
Exemplo: "3.99"
items[].​promotion.​promotion_remaining_chargesinteger or null
Padrão null
Exemplo: "3"
items[].​trial_periodinteger or null
Exemplo: "7"
Resposta
application/json
{
  "has_more": "false",
  "items": []
}

Cupons

Operações

Assinaturas

Operações

Payment accounts

Operações