Sign in
billing-profile

Retrieve billing profile

Changed on

Retrieve the billing profile of the active scope.

get/billing-profile/retrieve_billing_profile/

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sessionid

Headers

X-Organization-Idstring

Selects the active organization for this request. Optional for callers that belong to exactly one active organization — the single membership is resolved implicitly. Required when the caller has two or more active memberships; omitting it in that case returns 400. If the header names an organization the caller is not an active member of, the server returns 403.

Response

idinteger required
contact_first_namestring required
contact_last_namestring
contact_emailstring email required
contact_phonestring
document_type'CPF' | 'CNPJ' | 'DNI' | 'CI' | 'RUT' | 'SSN' | 'EIN' | 'PASSPORT' | 'OTHER' required
  • CPF - CPF
  • CNPJ - CNPJ
  • DNI - DNI
  • CI - CI
  • RUT - RUT
  • SSN - SSN
  • EIN - EIN
  • PASSPORT - Passport
  • OTHER - Other
document_numberstring required
createdstring date-time required
modifiedstring date-time required

Changes

  • bbeb063561c2Revision changes
    • ▲

      the response property's maxLength was unset from 50 for the response status

    • ●

      added the new CI enum value to the response property for the response status

    • ●

      added the new CNPJ enum value to the response property for the response status

    • ●

      added the new CPF enum value to the response property for the response status

    • ●

      added the new DNI enum value to the response property for the response status

    • ●

      added the new EIN enum value to the response property for the response status

    • ●

      added the new OTHER enum value to the response property for the response status

    • ●

      added the new PASSPORT enum value to the response property for the response status

    • ●

      added the new RUT enum value to the response property for the response status

    • ●

      added the new SSN enum value to the response property for the response status

  • a5fdf3d27f1aRevision changes
    • ○

      added the new optional header request parameter X-Organization-Id

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status