TRtrytoku
Pix Automático

Obter Pix Automatic Configuration

Changed on

Devolve a configuração de cobrança do Pix Automático de uma Subscription.

get/brazil/pix_automatic_configuration/{id_subscription}

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/brazil/pix_automatic_configuration/{id_subscription}
  • Auth
    API key in header x-api-key

Path parameters

id_subscriptionstring required

Identificador da Subscription configurada.

Response

Configuração de cobrança registrada para a Subscription. Os campos sem valor são omitidos.

allow_retriesboolean nullable

Política de retentativas com que a recorrência foi cadastrada: com true, até 3 retentativas em 7 dias.

business_day_only_collectionboolean nullable

Quando true, a cobrança é enviada com o ajuste para dia útil, nos provedores que aceitam esse ajuste.

collection_dayinteger nullable

Dia do mês registrado na configuração. Hoje não é enviado ao banco nem usado no cálculo das cobranças.

collection_frequency'SEMANAL' | 'MENSAL' | 'TRIMESTRAL' | 'SEMESTRAL' | 'ANUAL'

Periodicidade da recorrência de uma cobrança do Pix Automático: de quanto em quanto tempo o banco do pagador autoriza o próximo débito. Os valores são os que o banco espera, por isso mantêm a nomenclatura em português.

created_atstring date-time required

Data em que a configuração foi criada.

days_between_retriesinteger nullable

Dias entre retentativas registrados na configuração. Hoje não é enviado ao banco nem usado no cálculo das cobranças.

deleted_atstring date-time nullable

Data em que a configuração foi excluída.

final_datestring date-time nullable

Data a partir da qual a recorrência deixa de valer.

first_payment_datestring date-time nullable

Data da primeira cobrança.

fixed_valuenumber nullable

Valor fixo de cada cobrança, em reais.

id_subscriptionstring required

Identificador da Subscription configurada.

maximum_valuenumber nullable

Valor máximo registrado na configuração. Hoje não é enviado ao banco nem usado no cálculo das cobranças.

minimum_valuenumber nullable

Valor mínimo autorizado para cada cobrança, em reais.

updated_atstring date-time required

Data da última alteração da configuração.

Example response

{
  "allow_retries": true,
  "created_at": "2025-10-29T20:38:19.984485",
  "first_payment_date": "2028-07-01T00:00:00",
  "id_subscription": "sub_uSikDF1U0fD6SKR46_gTUU7Pbm4Odl22",
  "minimum_value": 10,
  "updated_at": "2025-10-29T20:38:19.984485"
}

Changes

  • a6ef070075b1Revision changes
    • breaking

      response property allow_retries list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property business_day_only_collection list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property collection_day list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property first_payment_date list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property minimum_value list-of-types was widened by adding types null and number to media type application/json of response 200

    • breaking

      the response's property type changed from string to no type for status

    • info

      api operation id obter-configuração removed and replaced with get_pix_automatic_configuration

    • info

      api tag Pix Automático added

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added subschema #2 to the response property anyOf list for the response status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response's property default value true was removed for the status

    • info

      the response's property default value true was removed for the status

    • info

      the response's property default value 0 was removed for the status

    • info

      the response's property default value 0 was removed for the status