subscriptions

Retorna os itens de uma assinatura através do seu ID.

Utilize este método para listar os itens associados a uma assinatura. Leia a documentação sobre paginação.

get/v1/subscriptions/{id}/product_items

Request

  • Base URL
    //app.vindi.com.br/api (relative, and the document’s source URL is not known)
  • URL
    //app.vindi.com.br/api/v1/subscriptions/{id}/product_items
  • Auth
    HTTP basic

Path parameters

idinteger required

ID da assinatura cujos itens deverão ser retornados.

Query parameters

pageinteger

Page of results to fetch.

per_pageinteger

Number of results to return per page.

Response

Ok. Itens encontrados.

idinteger required

ID do item

status'active' | 'inactive' | 'deleted' required

Status do item

usesinteger

Número de ciclos de recorrência que utilizaram o produto.

cyclesinteger

Número de ciclos de recorrência onde o produto será aplicado a partir do momento de sua criação. Nulo significa duração ilimitada

quantityinteger

Quantidade do produto incluído na assinatura. Se não for informado, o valor '1' será utilizado

created_atstring required

Data e hora da criação do item

updated_atstring required

Data e hora da última atualização do item

Changes

No recorded changes to this operation across all 1 revision of this API.