> ## Documentation Index
> Fetch the complete documentation index at: https://docs.localpayment.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Criar uma assinatura

Este endpoint permite criar uma nova assinatura para um cliente. Criar uma assinatura envolve associar um cliente a um plano de assinatura específico e registrar suas informações de pagamento.


## OpenAPI

````yaml openapi/pt-br/localpayment.json POST /api/payin/subscriptions
openapi: 3.1.0
info:
  version: '1.0'
  title: Localpayment
  contact:
    name: Support
    url: mailto:support@localpayment.com
servers:
  - url: https://api.stage.localpayment.com
    description: Stage
security:
  - token: []
paths:
  /api/payin/subscriptions:
    post:
      summary: Criar uma assinatura
      operationId: create-a-subscription
      parameters:
        - name: Authorization
          in: header
          description: >-
            Token de acesso Bearer para autenticação. Este token é obtido nos
            endpoints [Obter token de acesso](/pt-br/reference/get-token) ou
            [Renovar token de acesso](/pt-br/reference/refresh-token).
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                paymentMethod:
                  type: object
                  properties:
                    type:
                      type: string
                      description: >-
                        [Tipo de método de
                        pagamento](/pt-br/reference/get-available-payment-methods).
                    code:
                      type: string
                      description: >-
                        [Código do método de
                        pagamento](/pt-br/reference/get-available-payment-methods).
                    flow:
                      type: string
                      description: >-
                        Define como os dados de pagamento são coletados:
                        `DIRECT` (dentro da requisição da API) ou `REDIRECT`
                        (formulário externo). Atualmente, somente `DIRECT` é
                        suportado.
                  required:
                    - type
                    - code
                    - flow
                  x-examples:
                    Example 1:
                      type: BankTransfer
                      code: '1005'
                      flow: DIRECT
                externalId:
                  type: string
                  description: >-
                    Um identificador único gerado pelo seu sistema para rastrear
                    a transação (alfanumérico e com hífens). Recomendamos o uso
                    do UUID4 para garantir a unicidade.
                country:
                  type: string
                  enum:
                    - COL
                    - MEX
                    - PER
                  description: >-
                    [País do documento](/pt-br/reference/country-codes). ISO
                    3166-1 alfa-3.
                amount:
                  type: number
                  description: Valor da transação.
                currency:
                  type: string
                  enum:
                    - COP
                    - MXN
                    - PEN
                    - USD
                  description: '[Códigos de moeda](/pt-br/reference/currency-codes).'
                accountNumber:
                  type: string
                  description: Número da conta Localpayment.
                conceptCode:
                  type: string
                  enum:
                    - '0001'
                    - '0002'
                    - '0003'
                    - '0004'
                    - '0005'
                    - '0006'
                    - '0007'
                    - '0008'
                    - '0009'
                    - '0010'
                    - '0011'
                    - '0012'
                    - '0013'
                    - '0014'
                    - '0015'
                    - '0016'
                    - '0017'
                    - '0018'
                    - '0019'
                    - '0020'
                    - '0021'
                    - '0022'
                    - '0023'
                    - '0024'
                    - '0025'
                    - '0026'
                    - '0027'
                    - '0028'
                    - '0029'
                    - '0030'
                    - '0031'
                    - '0032'
                    - '0033'
                    - '0034'
                    - '0035'
                    - '0036'
                    - '0037'
                    - '0038'
                    - '0039'
                    - '0040'
                  description: >-
                    Motivo do pagamento
                    ([código](/pt-br/reference/concept-codes)).
                comment:
                  type: string
                  description: Informações adicionais
                exchangeRateToken:
                  type: string
                  description: >-
                    Token fornecido pelo [serviço de
                    câmbio](/pt-br/reference/currency-exchange-quote) para
                    utilizar uma taxa de câmbio previamente acordada.
                payer:
                  type: object
                  description: Informações do pagador.
                  properties:
                    type:
                      type: string
                      enum:
                        - COMPANY
                        - INDIVIDUAL
                      description: Tipo do pagador.
                    name:
                      type: string
                      description: >-
                        Nome do pagador. Os caracteres permitidos dependem do
                        campo `type`: para `individual`, letras (incluindo
                        caracteres acentuados), espaços e pontos (`.`); para
                        `company`, o mesmo conjunto mais dígitos, sublinhado
                        (`_`) e hífen (`-`).
                      minLength: 2
                      maxLength: 255
                    lastName:
                      type: string
                      description: >-
                        Sobrenome do pagador. Obrigatório quando `type` é
                        `individual` e ignorado quando `type` é `company`. Os
                        caracteres permitidos dependem de `type`: para
                        `individual`, letras (incluindo caracteres acentuados),
                        espaços e pontos (`.`); para `company`, o mesmo conjunto
                        mais dígitos, sublinhado (`_`) e hífen (`-`).
                      minLength: 2
                      maxLength: 255
                    document:
                      type: object
                      description: Informações do documento de identidade do pagador.
                      properties:
                        type:
                          type: string
                          description: >-
                            O tipo de [documento de
                            identidade](/pt-br/reference/identity-document-types),
                            como Número de Identidade Nacional, Número de Seguro
                            Social ou Carteira de Motorista, dependendo do país
                            de emissão.
                          examples:
                            - RUC
                        id:
                          type: string
                          description: >-
                            Número do documento de identidade (geralmente um
                            número). Este número deve ser válido de acordo com
                            as regras para o tipo específico de documento.
                          examples:
                            - '1791234561009'
                      required:
                        - type
                        - id
                      examples:
                        - type: RUC
                          id: '1791234561009'
                    userReference:
                      type: string
                      description: Nome de usuário ou ID do pagador na sua plataforma.
                    email:
                      type: string
                      description: E-mail do usuário.
                    phone:
                      type: object
                      description: Número de telefone do pagador.
                      properties:
                        countryCode:
                          type: string
                          description: Código do país do telefone.
                        areaCode:
                          type: string
                          description: Código de área do país do telefone.
                        number:
                          type: string
                          description: Número de telefone.
                      required:
                        - countryCode
                        - areaCode
                        - number
                    birthDate:
                      type: string
                      description: Data de nascimento do pagador no formato `yyyy-mm-dd`.
                    nationality:
                      type: string
                      description: Nacionalidade do pagador.
                    address:
                      type: object
                      description: Endereço do pagador.
                      properties:
                        street:
                          type: string
                          description: Nome da rua.
                          examples:
                            - Independencia
                        number:
                          type: string
                          description: Número da rua.
                          examples:
                            - '123'
                        city:
                          type: string
                          description: Cidade.
                          examples:
                            - Cordoba
                        state:
                          type: string
                          description: Estado.
                          examples:
                            - Cordoba
                        country:
                          type: string
                          description: País do endereço.
                          examples:
                            - Argentina
                        zipCode:
                          type: string
                          description: CEP.
                          examples:
                            - X5000IUO
                        comment:
                          type: string
                          description: Informações adicionais sobre o endereço.
                          examples:
                            - Sucursal 123
                      examples:
                        - street: Independencia
                          number: '123'
                          city: Cordoba
                          state: Cordoba
                          country: ARG
                          zipCode: X5000IUO
                          comment: Sucursal 123
                  required:
                    - type
                    - name
                    - document
                    - email
                    - phone
                  x-examples:
                    Example 1:
                      beneficiary:
                        type: COMPANY
                        name: ITAU ARG
                        document:
                          type: CUIT
                          id: '20907920276'
                        userReference: Lorem
                        email: aldana@mail.com
                        phone:
                          countryCode: countryCode
                          areaCode: areaCode
                          number: phoneNumber
                        birthDate: '2021-11-08'
                        nationality: beneficiary nationality
                        address:
                          street: Beneficiary adress
                          number: '234'
                          city: City
                          state: Villa Rosa
                          country: Country
                          zipCode: '1411'
                          comment: TEST
                        bank:
                          name: ARG TEST
                          code: '007'
                          account:
                            type: C
                            number: '1234567891234567891234'
                intermediaries:
                  type: array
                  description: >-
                    Matriz de objetos Party. Representa outras partes na cadeia
                    de pagamento, visto que o usuário final não é seu cliente
                    direto. Considere a sequência da matriz: seu cliente deve
                    ser o primeiro elemento, o cliente do seu cliente deve ser o
                    segundo e assim por diante, até que não haja mais
                    intermediários.
                device:
                  type: object
                  properties:
                    id:
                      type: string
                      description: >-
                        ID do dispositivo Android / iPhone. Pode ficar em branco
                        para outros tipos de dispositivo, como PC / Mac.
                    ip:
                      type: string
                      description: Endereço IP do dispositivo
                    browser:
                      type: string
                      description: Navegador do dispositivo.
                metaData:
                  type: string
                  description: >-
                    Objeto não estruturado para registrar quaisquer metadados
                    que sejam significativos para você.
                commercialData:
                  type: object
                  description: >-
                    Informações adicionais relacionadas aos bens ou serviços
                    comercializados. 
                  properties:
                    lastName:
                      type: string
                      description: >-
                        Sobrenome da entidade comercial. Obrigatório quando o
                        valor representa uma pessoa física e ignorado quando
                        representa uma empresa. Caracteres permitidos: para
                        pessoa física, letras (incluindo caracteres acentuados),
                        espaços e pontos (`.`); para empresa, o mesmo conjunto
                        mais dígitos, sublinhado (`_`) e hífen (`-`).
                      minLength: 2
                      maxLength: 255
                    name:
                      type: string
                      description: >-
                        Nome da entidade comercial. Os caracteres permitidos
                        dependem de o valor representar uma pessoa física ou uma
                        empresa: para pessoa física, letras (incluindo
                        caracteres acentuados), espaços e pontos (`.`); para
                        empresa, o mesmo conjunto mais dígitos, sublinhado (`_`)
                        e hífen (`-`).
                      minLength: 2
                      maxLength: 255
                merchant:
                  type: object
                  description: Informações do comerciante.
                  properties:
                    type:
                      type: string
                      description: Tipo de comerciante.
                    name:
                      type: string
                      description: >-
                        Nome do comerciante. Os caracteres permitidos dependem
                        do campo `type`: para `individual`, letras (incluindo
                        caracteres acentuados), espaços e pontos (`.`); para
                        `company`, o mesmo conjunto mais dígitos, sublinhado
                        (`_`) e hífen (`-`).
                      minLength: 2
                      maxLength: 255
                    lastName:
                      type: string
                      description: >-
                        Sobrenome do comerciante. Obrigatório quando `type` é
                        `individual` e ignorado quando `type` é `company`. Os
                        caracteres permitidos dependem de `type`: para
                        `individual`, letras (incluindo caracteres acentuados),
                        espaços e pontos (`.`); para `company`, o mesmo conjunto
                        mais dígitos, sublinhado (`_`) e hífen (`-`).
                      minLength: 2
                      maxLength: 255
                    document:
                      type: object
                      description: Informações do documento de identidade do comerciante.
                      properties:
                        type:
                          type: string
                          description: >-
                            O tipo de [documento de
                            identidade](/pt-br/reference/identity-document-types),
                            como Número de Identidade Nacional, Número de Seguro
                            Social ou Carteira de Motorista, dependendo do país
                            de emissão.
                          examples:
                            - RUC
                        id:
                          type: string
                          description: >-
                            Número do documento de identidade (geralmente um
                            número). Este número deve ser válido de acordo com
                            as regras para o tipo específico de documento.
                          examples:
                            - '1791234561009'
                      examples:
                        - type: RUC
                          id: '1791234561009'
                    phone:
                      type: object
                      description: Número de telefone do comerciante.
                      properties:
                        countryCode:
                          type: string
                          description: Código do país do telefone.
                        areaCode:
                          type: string
                          description: Código de área do país do telefone.
                        number:
                          type: string
                          description: Número de telefone.
                    email:
                      type: string
                      description: E-mail do comerciante.
                    userReference:
                      type: string
                      description: Nome de usuário ou ID do comerciante na sua plataforma.
                    address:
                      type: object
                      description: Endereço do comerciante.
                      properties:
                        street:
                          type: string
                          description: Nome da rua.
                          examples:
                            - Independencia
                        number:
                          type: string
                          description: Número da rua.
                          examples:
                            - '123'
                        city:
                          type: string
                          description: Cidade.
                          examples:
                            - Cordoba
                        state:
                          type: string
                          description: Estado.
                          examples:
                            - Cordoba
                        country:
                          type: string
                          description: País do endereço.
                          examples:
                            - Argentina
                        zipCode:
                          type: string
                          description: CEP.
                          examples:
                            - X5000IUO
                        comment:
                          type: string
                          description: Informações adicionais sobre o endereço.
                          examples:
                            - Sucursal 123
                      examples:
                        - street: Independencia
                          number: '123'
                          city: Cordoba
                          state: Cordoba
                          country: ARG
                          zipCode: X5000IUO
                          comment: Sucursal 123
                    nationality:
                      type: string
                      description: Nacionalidade do comerciante.
                    birthDate:
                      type: string
                      description: Data de nascimento do comerciante no formato aaaa-mm-dd.
                  x-examples:
                    Example 1:
                      merchant:
                        type: COMPANY
                        name: Merchant Name
                        lastName: Merchant LastName
                        document:
                          type: Type Document
                          id: ID Document
                        userReference: additional information
                        email: email@Merchant.address
                        phone:
                          countryCode: '55'
                          areaCode: '55'
                          number: '66666666'
                        birthDate: '2001-01-01'
                        nationality: Merchant Nacionality
                        address:
                          street: Av Merchant Address
                          number: '1234'
                          city: City Name
                          state: State Name
                          country: Country Name
                          zipCode: Zip Code
                          comment: Additional address information
                card:
                  type: object
                  description: 'Dados do cartão de débito do pagador. '
                  properties:
                    name:
                      type: string
                      description: ' Nome do titular do cartão, conforme impresso na frente do cartão de débito.'
                    number:
                      type: string
                      description: Número do cartão (PAN).
                    cvv:
                      type: string
                      description: Valor de verificação do cartão
                    expirationMonth:
                      type: string
                      description: Mês de validade do cartão. Formato `MM`.
                      examples:
                        - '01'
                    expirationYear:
                      type: string
                      description: Ano de validade do cartão. Formato `YYYY`.
                      examples:
                        - '2025'
                    token:
                      type: string
                      description: >-
                        Utilize um cartão previamente tokenizado enviando o
                        token.
                  required:
                    - name
                    - number
                    - cvv
                    - expirationMonth
                    - expirationYear
                invoice:
                  type: string
                  description: Referência da fatura.
                item:
                  type: object
                  description: Lista de itens vendidos.
                  properties:
                    id:
                      type: string
                      description: ' ID do item.'
                    quantity:
                      type: number
                      description: ' ID do item.'
                    categoryId:
                      type: string
                      description: Categoria do item.
                    pictureUrl:
                      type: string
                      description: ' URL que aponta para uma imagem do item.'
                    description:
                      type: string
                      description: Descrição do item.
                    title:
                      type: string
                      description: "Título do item.\r\n"
                    unitPrice:
                      type: number
                      description: Preço unitário
                shipments:
                  type: object
                  description: Lista de endereços de entrega
                  properties:
                    city:
                      type: string
                      description: Cidade
                    number:
                      type: string
                      description: Número do endereço
                    street:
                      type: string
                      description: Endereço
                    country:
                      type: string
                      description: País
                    state:
                      type: string
                      description: Estado/Província
                    comment:
                      type: string
                      description: Informações adicionais
                    zipCode:
                      type: string
                      description: CEP
                beneficiary:
                  type: object
                  description: Informações do beneficiário da conta.
                  properties:
                    type:
                      type: string
                      enum:
                        - INDIVIDUAL
                        - COMPANY
                      description: Tipo de beneficiário.
                    name:
                      type: string
                      description: >-
                        Nome do beneficiário. Os caracteres permitidos dependem
                        do campo `type`: para `individual`, letras (incluindo
                        caracteres acentuados), espaços e pontos (`.`); para
                        `company`, o mesmo conjunto mais dígitos, sublinhado
                        (`_`) e hífen (`-`).
                      minLength: 2
                      maxLength: 255
                    lastName:
                      type: string
                      description: >-
                        Sobrenome do beneficiário. Obrigatório quando `type` é
                        `individual` e ignorado quando `type` é `company`. Os
                        caracteres permitidos dependem de `type`: para
                        `individual`, letras (incluindo caracteres acentuados),
                        espaços e pontos (`.`); para `company`, o mesmo conjunto
                        mais dígitos, sublinhado (`_`) e hífen (`-`).
                      minLength: 2
                      maxLength: 255
                    document:
                      type: object
                      description: Informações do documento de identidade do beneficiário.
                      properties:
                        type:
                          type: string
                          description: >-
                            O tipo de [documento de
                            identidade](/pt-br/reference/identity-document-types),
                            como Número de Identidade Nacional, Número de Seguro
                            Social ou Carteira de Motorista, dependendo do país
                            de emissão.
                        id:
                          type: string
                          description: >-
                            Número do documento de identidade (geralmente um
                            número). Este número deve ser válido de acordo com
                            as regras para o tipo específico de documento.
                type:
                  type: string
                  enum:
                    - SOFTWARE
                    - STREAMING
                    - CONTENT
                    - PRODUCTS
                    - MEMBERSHIP
                  description: Especifica a categoria de assinatura.
                autoRecurring:
                  type: object
                  description: Propriedades da assinatura
                  properties:
                    type:
                      type: string
                      enum:
                        - day
                        - month
                        - custom
                      description: >-
                        Define a unidade do intervalo de recorrência. Para
                        recorrência sob demanda, envie o parâmetro com
                        `value=custom`.
                    trialDays:
                      type: number
                      description: Número de dias de teste da assinatura.
                  required:
                    - type
                retry:
                  type: object
                  description: Opções de nova tentativa de Payin.
                  properties:
                    repetitions:
                      type: number
                      description: Número de vezes que a cobrança será tentada novamente.
                    intervalUnit:
                      type: string
                      enum:
                        - day
                        - hour
                      description: >-
                        A unidade de tempo em que as novas tentativas serão
                        executadas. Valores permitidos: `day` e `hour`.
                    intervalValue:
                      type: string
                      description: >-
                        Intervalo em que as novas tentativas serão realizadas.
                        Define o número de unidades de tempo entre as
                        tentativas.
                discount:
                  type: object
                  description: Opções de desconto.
                  properties:
                    amount:
                      type: string
                      description: Valor a cobrar do seu usuário final.
                    period:
                      type: number
                      description: Período de desconto.
                  required:
                    - amount
                    - period
              required:
                - paymentMethod
                - externalId
                - country
                - amount
                - currency
                - accountNumber
                - conceptCode
                - payer
                - card
                - type
                - autoRecurring
              x-examples:
                Example 1:
                  paymentMethod:
                    type: CreditCard
                    code: '1000'
                    flow: DIRECT
                  externalId: '1662647310'
                  country: ARG
                  amount: 100
                  currency: ARS
                  accountNumber: '{{accountNumber}}'
                  conceptCode: '0001'
                  comment: subs test 1 del 7/9 xdia
                  merchant:
                    type: INDIVIDUAL
                    name: Obi Wan
                    lastname: Kenobi
                    document:
                      type: DNI
                      id: '12345678'
                    userReference: abc123
                    email: obiwankenobi@starwars.com
                    phone:
                      countryCode: '54'
                      areaCode: '11'
                      number: '98789632'
                    birthdate: '2000-01-01'
                    nationality: Argentinian
                    address:
                      street: Charruas
                      number: '938'
                      city: Hurlingham
                      state: state
                      country: ARG
                      zipCode: '1688'
                      comment: portero 801
                  payer:
                    type: INDIVIDUAL
                    name: Luke
                    lastname: Skywalker
                    document:
                      id: '37993830'
                      type: DNI
                    email: jane.doe@example.com
                    phone:
                      countryCode: '1'
                      areaCode: '11'
                      number: '98789632'
                    birthdate: 01/01/1990
                    nationality: American
                    address:
                      street: Siempre viva
                      number: '1234'
                      city: Springfield
                      state: Ohio
                      country: USA
                      zipCode: '1686'
                      comment: May the force be with you, always!
                  card:
                    name: APRO
                    number: '4509953566233704'
                    cvv: '123'
                    expirationMonth: '11'
                    expirationYear: '2025'
                    installments: 1
                  type: SOFTWARE
                  autoRecurring:
                    type: day
            examples:
              200 - Suscription:
                value:
                  paymentMethod:
                    type: CreditCard
                    code: '1000'
                    flow: DIRECT
                  externalId: 820d6e89-3715-4296-9975-def5c7750f65
                  country: ARG
                  amount: 100
                  currency: ARS
                  accountNumber: '{{accountNumber}}'
                  conceptCode: '0001'
                  comment: Test
                  merchant:
                    type: COMPANY
                    name: Company
                    document:
                      type: DNI
                      id: '12345678'
                    userReference: abc123
                    email: merchant@mail.com
                    phone:
                      countryCode: '54'
                      areaCode: '11'
                      number: '98781234'
                  payer:
                    type: INDIVIDUAL
                    name: John
                    lastname: Doe
                    document:
                      id: '37993812'
                      type: DNI
                    email: john.doe@example.com
                    phone:
                      countryCode: '1'
                      areaCode: '11'
                      number: '98789123'
                  card:
                    name: APRO
                    number: '4000000000000002'
                    cvv: '123'
                    expirationMonth: '11'
                    expirationYear: '2029'
                    installments: 1
                  type: SOFTWARE
                  autoRecurring:
                    type: day
              COL - Subscription:
                summary: COL - Subscription
                value:
                  paymentMethod:
                    type: CreditCard
                    code: '1900'
                    flow: DIRECT
                  externalId: 550e8400-e29b-41d4-a716-446655440000
                  country: COL
                  amount: 100
                  currency: COP
                  accountNumber: '{{yourLocalpaymentAccountNumber}}'
                  conceptCode: '0001'
                  comment: Subscription
                  merchant:
                    type: COMPANY
                    name: Example Company S.A.
                    document:
                      type: NIT
                      id: '900123456'
                  payer:
                    type: INDIVIDUAL
                    name: Jane
                    lastName: Doe
                    document:
                      type: CC
                      id: '1234567890'
                    email: jane.doe@example.com
                  card:
                    name: Jane Doe
                    number: '4000000000000002'
                    cvv: '123'
                    expirationMonth: '12'
                    expirationYear: '2029'
                    installments: 1
                  type: SOFTWARE
                  autoRecurring:
                    repetitions: 2
                    type: day
              PER - Subscription (PEN):
                summary: PER - Subscription (PEN)
                value:
                  paymentMethod:
                    type: CreditCard
                    code: '6000'
                    flow: DIRECT
                  externalId: 550e8400-e29b-41d4-a716-446655440000
                  country: PER
                  amount: 100
                  currency: PEN
                  accountNumber: '{{yourLocalpaymentAccountNumber}}'
                  conceptCode: '0001'
                  comment: Subscription
                  merchant:
                    type: COMPANY
                    name: Example Company S.A.
                    document:
                      type: RUC
                      id: '20123456789'
                  payer:
                    type: INDIVIDUAL
                    name: Jane
                    lastName: Doe
                    document:
                      type: DNI
                      id: '12345678'
                    email: jane.doe@example.com
                  card:
                    name: Jane Doe
                    number: '4000000000000002'
                    cvv: '123'
                    expirationMonth: '12'
                    expirationYear: '2029'
                    installments: 1
                  type: SOFTWARE
                  autoRecurring:
                    repetitions: 2
                    type: day
              PER - Subscription (USD):
                summary: PER - Subscription (USD)
                value:
                  paymentMethod:
                    type: CreditCard
                    code: '6004'
                    flow: DIRECT
                  externalId: 550e8400-e29b-41d4-a716-446655440000
                  country: PER
                  amount: 100
                  currency: USD
                  accountNumber: '{{yourLocalpaymentAccountNumber}}'
                  conceptCode: '0001'
                  comment: Subscription
                  merchant:
                    type: COMPANY
                    name: Example Company S.A.
                    document:
                      type: RUC
                      id: '20123456789'
                  payer:
                    type: INDIVIDUAL
                    name: Jane
                    lastName: Doe
                    document:
                      type: DNI
                      id: '12345678'
                    email: jane.doe@example.com
                  card:
                    name: Jane Doe
                    number: '4000000000000002'
                    cvv: '123'
                    expirationMonth: '12'
                    expirationYear: '2029'
                    installments: 1
                  type: SOFTWARE
                  autoRecurring:
                    repetitions: 2
                    type: day
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscriptionId:
                    type: string
                    description: Identificador único para a assinatura.
                  status:
                    type: object
                    title: status
                    description: Status da operação.
                    properties:
                      code:
                        type: string
                        description: >-
                          [Código de
                          status](/pt-br/reference/transaction-status-error-codes).
                      description:
                        type: string
                        description: >-
                          [Descrição do
                          status](/pt-br/reference/transaction-status-error-codes).
                      detail:
                        type: string
                        description: Informações adicionais sobre o status.
                  creationDate:
                    type: string
                    description: >-
                      Data e hora em que a assinatura foi criada. O registro de
                      data e hora segue o formato ISO 8601.
                  nextPaymentDate:
                    type: string
                    description: >-
                      Data e hora em que o próximo pagamento da assinatura
                      vence. O registro de data e hora segue o formato ISO 8601.
                  payments:
                    type: array
                    description: >-
                      Conjunto de objetos representando os pagamentos associados
                      à assinatura.
                    items:
                      type: object
                      properties:
                        externalId:
                          type: string
                          description: >-
                            Um identificador único gerado pelo seu sistema para
                            rastrear a transação (alfanumérico e com hífens).
                            Recomendamos o uso do UUID4 para garantir a
                            unicidade.
                        internalId:
                          type: string
                          description: Identificador de transação da Localpayment.
                        status:
                          type: object
                          title: status
                          description: Status da operação.
                          properties:
                            code:
                              type: string
                              description: >-
                                [Código de
                                status](/pt-br/reference/transaction-status-error-codes).
                            description:
                              type: string
                              description: >-
                                [Descrição do
                                status](/pt-br/reference/transaction-status-error-codes).
                            detail:
                              type: string
                              description: Informações adicionais sobre o status.
                x-examples:
                  Example 1:
                    subscriptionId: 133640f9-ac06-49fc-aa82-08bfe52ceb5e
                    status:
                      code: '105'
                      description: INPROGRESS
                      detail: The subscription is in progress
                    creationDate: '2022-05-31T15:05:47.665+00:00'
                    nextPaymentDate: '2022-06-30T15:05:47.665+00:00'
                    payments:
                      - externalId: bb7d32e5-04da-4b8a-856f-8caf89d986ea
                        internalId: 9977c353-ce00-48fd-b3ac-f685bce30895
                        status:
                          code: '103'
                          description: APPROVED
                          detail: The payin was confirmed but not credited yet
              examples:
                200 - Subscription:
                  value:
                    subscriptionId: 133640f9-ac16-49fc-aa82-08bfe52ceb5e
                    status:
                      code: '105'
                      description: INPROGRESS
                      detail: The subscription is in progress
                    creationDate: '2024-05-31T15:05:47.665+00:00'
                    nextPaymentDate: '2024-06-30T15:05:47.665+00:00'
                    payments:
                      - externalId: bb7d3235-04da-4b8a-85bf-8caf89d986ea
                        internalId: 9977c453-ce00-48fd-baac-f685bce30895
                        status:
                          code: '103'
                          description: APPROVED
                          detail: The payin was confirmed but not credited yet
                COL - Subscription:
                  summary: COL - Subscription
                  value:
                    type: SOFTWARE
                    externalId: 550e8400-e29b-41d4-a716-446655440000
                    internalId: 5aced5da-40c1-4bec-85ff-c8cd1bcb4526
                    country: COL
                    currency: COP
                    accountNumber: '{{yourLocalpaymentAccountNumber}}'
                    status:
                      code: '105'
                      description: ACTIVE
                      detail: The subscription is active
                    date:
                      creationDate: '2024-01-15T10:30:00Z'
                      nextPaymentDate: '2024-01-16T10:30:00Z'
                    payments:
                      - externalId: f47ac10b-58cc-4372-a567-0e02b2c3d479
                        internalId: 9b2e4c1d-7a3f-4e8b-b6d5-2c1f0a9e8d7c
                        status:
                          code: '103'
                          description: APPROVED
                          detail: The payin was confirmed but not credited yet
                    errors: []
                PER - Subscription (PEN):
                  summary: PER - Subscription (PEN)
                  value:
                    type: SOFTWARE
                    externalId: 550e8400-e29b-41d4-a716-446655440000
                    internalId: 5aced5da-40c1-4bec-85ff-c8cd1bcb4526
                    country: PER
                    currency: PEN
                    accountNumber: '{{yourLocalpaymentAccountNumber}}'
                    status:
                      code: '105'
                      description: ACTIVE
                      detail: The subscription is active
                    date:
                      creationDate: '2024-01-15T10:30:00Z'
                      nextPaymentDate: '2024-01-16T10:30:00Z'
                    payments:
                      - externalId: f47ac10b-58cc-4372-a567-0e02b2c3d479
                        internalId: 9b2e4c1d-7a3f-4e8b-b6d5-2c1f0a9e8d7c
                        status:
                          code: '103'
                          description: APPROVED
                          detail: The payin was confirmed but not credited yet
                    errors: []
                PER - Subscription (USD):
                  summary: PER - Subscription (USD)
                  value:
                    type: SOFTWARE
                    externalId: 550e8400-e29b-41d4-a716-446655440000
                    internalId: 5aced5da-40c1-4bec-85ff-c8cd1bcb4526
                    country: PER
                    currency: USD
                    accountNumber: '{{yourLocalpaymentAccountNumber}}'
                    status:
                      code: '105'
                      description: ACTIVE
                      detail: The subscription is active
                    date:
                      creationDate: '2024-01-15T10:30:00Z'
                      nextPaymentDate: '2024-01-16T10:30:00Z'
                    payments:
                      - externalId: f47ac10b-58cc-4372-a567-0e02b2c3d479
                        internalId: 9b2e4c1d-7a3f-4e8b-b6d5-2c1f0a9e8d7c
                        status:
                          code: '103'
                          description: APPROVED
                          detail: The payin was confirmed but not credited yet
                    errors: []
        '400':
          description: Solicitação inválida.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: object
                    title: status
                    description: Status da operação.
                    properties:
                      code:
                        type: string
                        description: >-
                          [Código de
                          status](/pt-br/reference/transaction-status-error-codes).
                      description:
                        type: string
                        description: >-
                          [Descrição do
                          status](/pt-br/reference/transaction-status-error-codes).
                      detail:
                        type: string
                        description: Informações adicionais sobre o status.
                  errors:
                    type: array
                    description: Lista de erros que ocorreram durante a transação.
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                          description: Código de erro.
                        detail:
                          type: string
                          description: Detalhes do erro.
                x-examples:
                  Example 1:
                    status:
                      code: '501'
                      description: REJECTED
                      detail: Country not found
                    errors:
                      - code: '501'
                        detail: Country not found
                      - code: '817'
                        detail: Invalid concept code
              examples:
                501 - Country not found:
                  value:
                    status:
                      code: '501'
                      description: REJECTED
                      detail: Country not found
                    errors:
                      - code: '501'
                        detail: Country not found
                      - code: '817'
                        detail: Invalid concept code
        '401':
          description: Não autorizado.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Informações adicionais sobre a resposta.
                  code:
                    type: string
                    description: Código de status.
                  messages:
                    type: array
                    description: Lista de mensagens.
                    items:
                      type: object
                      properties:
                        token_class:
                          type: string
                          description: Classe Token.
                        token_type:
                          type: string
                          description: Tipo de token.
                        message:
                          type: string
                          description: Mensagem com informações adicionais.
                x-examples:
                  Example 1:
                    detail: Given token not valid for any token type
                    code: token_not_valid
                    messages:
                      - token_class: AccessToken
                        token_type: access
                        message: Token is invalid or expired
              examples:
                401 - Token is invalid or expired:
                  value:
                    detail: Given token not valid for any token type
                    code: token_not_valid
                    messages:
                      - token_class: AccessToken
                        token_type: access
                        message: Token is invalid or expired
      security:
        - token: []
      servers:
        - url: https://api.stage.localpayment.com
          description: Stage
components:
  securitySchemes:
    token:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.