Listar assinaturas

GET 
/v1/subscriptions

Retorna todas as assinaturas, ordenadas por data de criação, com as mais recentes primeiro.

Request

Query Parameters

starting_after string
Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.
Example: obj_5f92f01728e009f403d8502e

Responses

200

Um objeto com data contendo um array de Subscription após starting_after. Se vazio, não há mais itens. Essa solicitação nunca falha.

application/json

Schema

Schema

hasMore boolean
Informa se existem mais itens. Os próximos itens podem ser obtidos informando o ID do último item no startingAfter.
Example: true

data

object[]

Uma lista de assinaturas

Array [

id string

Identificador exclusivo para o objeto.

Example: subs_5f92f01728e009f403d8502e

name string

Nome da assinatura.

Example: Loan created webhook

events

object[]

Lista de eventos.

Array [

eventType string

Nome do evento a ser utilizado na subscrição.

Example: loan.created

filters object

Filtros para o evento. Informar o nome do que deseja filtrar e um array com os possíveis valores.

Example: {"status":["canceled","open"]}

]

notification

object

url string

Url que será utilizada para o envio do evento.

Example: https://api.example.com/webhooks

headers object

Objeto que define os headers a ser utilizado na chamada HTTP para a url definida.

Example: {"Authorization":"key-12345"}

createdBy

object

clientId string

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientId string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

app string

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy

object

clientId string

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientId string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

app string

Nome da aplicação que criou a assinatura.

Example: backoffice

]

Example (from schema)

{
  "hasMore": true,
  "data": [
    {
      "id": "subs_5f92f01728e009f403d8502e",
      "name": "Loan created webhook",
      "events": [
        {
          "eventType": "loan.created",
          "filters": {
            "status": [
              "canceled",
              "open"
            ]
          }
        }
      ],
      "notification": {
        "url": "https://api.example.com/webhooks",
        "headers": {
          "Authorization": "key-12345"
        }
      },
      "createdBy": {
        "clientId": "client_identifier",
        "externalClientId": "string",
        "app": "backoffice"
      },
      "updatedBy": {
        "clientId": "client_identifier",
        "externalClientId": "string",
        "app": "backoffice"
      }
    }
  ]
}

Loading...