PATCH
/
v3
/
billing
/
credits-topups
/
{topupId}
Update Billing Credits Top-up Catalog Entry
curl --request PATCH \
  --url http://127.0.0.1:3333/v3/billing/credits-topups/{topupId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "id": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "key": "<string>",
  "credits": 1,
  "defaultCurrency": "brl",
  "price": 1,
  "prices": {
    "brl": 1,
    "usd": 1,
    "eur": 1,
    "gbp": 1
  },
  "stripeProductId": "<string>",
  "displayOrder": 1,
  "isPublic": true,
  "displayName": "<string>",
  "description": "<string>",
  "checkoutName": "<string>",
  "translations": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
topupId
integer
required
Required range: x > 0

Query Parameters

​
locale
string

Body

application/json
​
defaultCurrency
enum<string>
Available options:
brl,
usd,
eur,
gbp
​
price
number
Required range: x >= 0
​
prices
object
​
stripeProductId
string | null
Minimum string length: 1
​
displayOrder
integer
Required range: x >= 0
​
isPublic
boolean
​
translations
object

Response

Default Response

​
id
number
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
key
string
required
​
credits
integer
required
Required range: x > 0
​
defaultCurrency
enum<string>
required
Available options:
brl,
usd,
eur,
gbp
​
price
number
required
Required range: x >= 0
​
prices
object
required
​
stripeProductId
string | null
required
​
displayOrder
integer
required
Required range: x >= 0
​
isPublic
boolean
required
​
displayName
string
required
​
description
string
required
​
checkoutName
string
required
​
translations
object
required