Skip to main content
PATCH
/
v1
/
subscriptions
/
settings
Atualizar configurações do cliente
curl --request PATCH \
  --url https://api.malga.io/v1/subscriptions/settings \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Client-Id: <api-key>' \
  --data '
{
  "retryPolicy": [
    {
      "daysAfterLastAttempt": 1
    },
    {
      "daysAfterLastAttempt": 4
    },
    {
      "daysAfterLastAttempt": 9
    },
    {
      "daysAfterLastAttempt": 16
    }
  ],
  "statementDescriptor": "MINHA EMPRESA",
  "cancelAfterAllRetries": false
}
'
{
  "clientId": "e234eeb3-483d-4df2-87eb-1e2be5cdaccd",
  "retryPolicy": [
    {
      "daysAfterLastAttempt": 1
    },
    {
      "daysAfterLastAttempt": 4
    },
    {
      "daysAfterLastAttempt": 9
    },
    {
      "daysAfterLastAttempt": 16
    }
  ],
  "cancelAfterAllRetries": false,
  "createdAt": "2025-01-31T10:00:00Z",
  "updatedAt": "2025-01-31T15:30:00Z",
  "statementDescriptor": "MINHA EMPRESA"
}

Authorizations

​
X-Client-Id
string
header
required
​
X-Api-Key
string
header
required

Body

application/json
​
retryPolicy
object[]

Política de retentativas para pagamentos falhados

Required array length: 1 - 6 elements
Example:
[
  { "daysAfterLastAttempt": 1 },
  { "daysAfterLastAttempt": 4 },
  { "daysAfterLastAttempt": 9 },
  { "daysAfterLastAttempt": 16 }
]
​
statementDescriptor
string

Texto que aparece na fatura do cartão de crédito

Maximum string length: 25
Example:

"MINHA EMPRESA"

​
cancelAfterAllRetries
boolean

Se a assinatura deve ser cancelada após todas as retentativas falharem

Example:

false

Response

Success

​
clientId
string<uuid>
required

Identificador do cliente

Example:

"e234eeb3-483d-4df2-87eb-1e2be5cdaccd"

​
retryPolicy
object[]
required

Política de retentativas configurada

Example:
[
  { "daysAfterLastAttempt": 1 },
  { "daysAfterLastAttempt": 4 },
  { "daysAfterLastAttempt": 9 },
  { "daysAfterLastAttempt": 16 }
]
​
cancelAfterAllRetries
boolean
required

Se a assinatura deve ser cancelada após todas as retentativas falharem

Example:

false

​
createdAt
string<date-time>
required

Data de criação das configurações

Example:

"2025-01-31T10:00:00Z"

​
updatedAt
string<date-time>
required

Data da última atualização das configurações

Example:

"2025-01-31T15:30:00Z"

​
statementDescriptor
string

Texto que aparece na fatura do cartão de crédito

Example:

"MINHA EMPRESA"