Monitoramento

Adiciona contrato a uma assinatura de monitoramento

post/monitoring/subscriptions/{subscription_id}/contract

Request

Base URL
https://api.b2b.usezapay.com.br/v2
Auth
HTTP basic
TypeScript
https://skmtc.dev/usezapay/apis/zapi/docs/monitoring/subscriptions/:subscription_id/contract/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

subscription_idstring uuid required

Identificador da assinatura

Request body

Example request

{
  "driver": {
    "name": "João da Silva",
    "document": "123.456.789-00",
    "cnh": "12345678900",
    "cnh_expiration_date": "2022-12-31",
    "first_cnh_date": "2010-01-01",
    "birth_date": "1990-01-01"
  }
}

Response

Successful Response

idstring uuid required

Identificador da assinatura

external_idstring nullable

Identificador externo

created_atstring date-time required

Data de criação

next_search_atstring date nullable

Data da próxima busca

plan_idstring uuid required

Identificador do plano

is_activeboolean required

Indica se a assinatura está ativa

is_canceledboolean required

Indica se a assinatura foi cancelada

Changes

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