> ## 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.

# Atualizar uma assinatura

Este serviço permite que você atualize os detalhes da sua assinatura, garantindo a continuidade ininterrupta dos seus pagamentos recorrentes.


## OpenAPI

````yaml openapi/pt-br/localpayment.json POST /api/payin/subscriptions/{externalId}
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/{externalId}:
    post:
      summary: Atualizar uma assinatura
      operationId: update-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
        - name: externalId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                amount:
                  type: number
                  description: Valor da transação.
                card:
                  type: object
                  description: Dados do cartão 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
                autoRecurring:
                  type: object
                  description: Propriedades da assinatura
                  properties:
                    repetitions:
                      type: integer
                      description: >-
                        Quantas vezes este pagamento será cobrado. Para
                        recorrência sob demanda, envie o parâmetro com
                        `value=0`.
                    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:
                    - repetitions
                    - 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
                dateToUpdate:
                  type: string
                  description: >-
                    Aplica-se somente quando a atualização solicitada precisar
                    ser aplicada a uma data futura. Formato: `YYYY-MM-DD`.
              required:
                - amount
                - card
                - 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:
                    repetitions: 1
                    type: day
            examples:
              200 - Suscription:
                value:
                  dateToUpdate: '2025-01-30'
                  amount: 16000
                  autoRecurring:
                    repetitions: '3'
                    type: month
                    trialDays: '0'
                  retry:
                    repetitions: 2
                    intervalUnit: day
                    intervalValue: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                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
                    description: Status da operação.
                    properties:
                      code:
                        type: string
                        description: Código de status.
                      description:
                        type: string
                        description: Descrição do status.
                      detail:
                        type: string
                        description: Detalhes do status.
                  errors:
                    type: array
                    description: Lista de erros que ocorreram durante a transação.
                    items:
                      type: object
                x-examples:
                  Example 1:
                    externalId: 564b161a-76ba-4a84-b5cf-583f2df8c377
                    internalId: 52425bbd-b68b-4abc-9480-5ae88d53adb3
                    status:
                      code: '107'
                      description: APPROVED
                      detail: Update subscription success
                    errors: []
              examples:
                107 - Update subscription success:
                  value:
                    externalId: 564b161a-76ba-4a84-b5cf-583f2df8c377
                    internalId: 52425bbd-b68b-4abc-9480-5ae88d53adb3
                    status:
                      code: '107'
                      description: APPROVED
                      detail: Update subscription success
                    errors: []
        '400':
          description: Solicitação inválida
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: object
                    description: Status da operação.
                    properties:
                      code:
                        type: string
                        description: Código de status.
                      description:
                        type: string
                        description: Descrição do status.
                      detail:
                        type: string
                        description: Detalhes do status.
                x-examples:
                  Example 1:
                    status:
                      code: '400'
                      description: ERROR
                      detail: Invalid operation
              examples:
                400 - Invalid operation:
                  value:
                    status:
                      code: '400'
                      description: ERROR
                      detail: Invalid operation
      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.