PATCH
/settings/statement-descriptorUpdates the statement descriptor settings for your account.
Paddle sets preview based on name, so you can't update it directly.
Returns a statement_descriptor_invalid_name error if the supplied name doesn't meet the format requirements, a statement_descriptor_in_use error if the supplied name is already in use, and a statement_descriptor_not_found error if no statement descriptor exists for your account yet.
If successful, your response includes a copy of the updated statement descriptor settings entity.
Requires
statement_descriptor.write permission.Request body
namestring
Example:
AEROEDITName that appears on the customer's bank or card statement. 2-10 characters. May contain uppercase letters, digits, spaces, and dots; must contain at least one letter; dots can't be the first or last character.
Length: 2–10
Pattern:
^[A-Z\d ][A-Z\d. ]*[A-Z\d ]$Response (200)
dataobjectrequired
Represents the statement descriptor settings for your account.
namestringrequired
Example:
AEROEDITName that appears on the customer's bank or card statement. 2-10 characters. May contain uppercase letters, digits, spaces, and dots; must contain at least one letter; dots can't be the first or last character.
Length: 2–10
Pattern:
^[A-Z\d ][A-Z\d. ]*[A-Z\d ]$previewobjectrequired
What a customer sees on their statement. Set automatically by Paddle based on name.
Which value applies depends on how the customer pays, which isn't something you choose.
defaultstringrequired
Example:
PADDLE.NET* AEROEDITDescriptor shown for most payments: the Paddle prefix followed directly by
name.paypalstringrequired
Example:
PAYPAL *PADDLE.NETDescriptor shown when the payment is made with PayPal.
metaobjectrequired
Information about this response.
request_idstringrequired
Example:
b15ec92e-8688-40d4-a04d-f44cbec93355Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.
{ "name": "AEROEDIT"}{ "data": { "name": "AEROEDIT", "preview": { "default": "PADDLE.NET* AEROEDIT", "paypal": "PAYPAL *PADDLE.NET" } }, "meta": { "request_id": "13cbcb2f-6a71-4b09-8a05-4c9e11b10c11" }}