Settings

Update statement descriptor settings

Changed on

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

patch/settings/statement-descriptor

Request

  • Base URL
    https://sandbox-api.paddle.com
  • Auth
    HTTP bearer

Request body

namestring

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

Example request

{
  "name": "AEROEDIT"
}

Response

The request has succeeded.

Example response

{
  "data": {
    "name": "AEROEDIT",
    "preview": {
      "default": "PADDLE.NET* AEROEDIT",
      "paypal": "PAYPAL *PADDLE.NET"
    }
  },
  "meta": {
    "request_id": "b15ec92e-8688-40d4-a04d-f44cbec93355"
  }
}

Changes