For AI agents and LLMs: a structured documentation index is available at /llms.txt. Every page has a Markdown sibling — append .md to any URL.

Skip to content
Docs

Success responses

When a request is successful, Paddle returns a data object or array with a 2xx HTTP response code. List endpoints return a data array and metadata object with pagination information.

AI summary

Describes the structure of Paddle API success responses: a data object or array containing the entity, a meta object with request metadata, and the HTTP status code to expect for each operation type.

  • • Create operations return a 201 status code with the full new entity including generated fields and defaults; all other successful read and update operations return 200.
  • • Delete operations (only available for notification destinations and payment methods) return a 204 with no response body.
  • • Update responses return the complete entity including fields you didn't change, so you can verify the full state after a PATCH.

The Paddle API returns requested entities in a data object or array when a response body is present. In most cases, it also returns a meta object with information about the request, including pagination information for list operations.

Success responses return a 2xx response code.

List entities

When you successfully list entities, Paddle returns:

  • A data array that includes a paginated list of requested entities.
  • A meta object that includes pagination information.

The response code is 200.

Get an entity

When you successfully get an entity, Paddle returns:

  • A data object with the requested entity.
  • A meta object with information about the request.

The response code is 200.

Create an entity

When you successfully create an entity, Paddle returns:

  • A data object with the created entity.
  • A meta object with information about the request.

All the fields against the new entity are returned, including any generated or calculated fields. If you omitted optional fields, Paddle returns those with the default values.

The response code is 201.

Update an entity

The Paddle API generally uses the PATCH method to update entities.

When you successfully update an entity, Paddle returns:

  • A data object with the updated entity.
  • A meta object with information about the request.

All the fields against the updated entity are returned, including fields that you didn't change.

The response code is 200.

Delete an entity

Most entities can't be deleted. Instead, you can archive them.

For entities that can be deleted, no response is returned. The response code is 204.

Was this page helpful?