Success responses

Success responses generally return a 2xx response code.

Paddle always returns requested entities in a data object. If you’re working with a list endpoint, Paddle also returns a meta object with pagination information.

When there’s an error, the API returns an error object instead.

Get an entity

When you get an entity, Paddle returns a single data object with that entity.

For example:

{
  "data": {
      "id": "pro_71jbvv7LfRKYp19gtRLtkn"
      "name": "Premium",
      "status": "active",
      "description": "Everything in Basic, plus advanced marketing automation and reporting.",
      "tax_category": "saas",
      "image_url": "https://cdn.paddle.com/products/pro_71jbvv7LfRKYp19gtRLtkn.png"
    }
}

List entities

When you list entities, Paddle returns:

A data object that includes the entities returned.
A meta object that includes pagination information.

For example:

{
  "data": [
    {
      "id": "pro_71jbvv7LfRKYp19gtRLtkn"
      "name": "Premium",
      "status": "active",
      "description": "Everything in Basic, plus advanced marketing automation and reporting.",
      "tax_category": "saas",
      "image_url": "https://cdn.paddle.com/images/pro_71jbvv7LfRKYp19gtRLtkn.png"
    },
    {
      "id": "pro_31olbiv4LfLVYp19gtRLtkn",
      "name": "Basic",
      "status": "active",
      "description": "The perfect plan for growing businesses.",
      "tax_category": "saas",
      "image_url": "https://cdn.paddle.com/images/pro_31olbiv4LfLVYp19gtRLtkn.png"
    }
  ],
  "meta": {
    "pagination": {
      "per_page": 2,
      "next": "api.paddle.com/products?after=pro_31olbiv4LfLVYp19gtRLtkn",
      "estimated_total": 999,
      "has_more": true
    }
  }
}

Create an entity

When you create an entity, Paddle returns a single data object with a copy of the new entity if successful.

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.

For example:

{
  "name": "Premium",
  "tax_category": "saas"
}

{
  "data": {
    "id": "pro_71jbvv7LfRKYp19gtRLtkn",
    "status": "active",
    "name": "Premium",
    "description": null,
    "tax_category": "saas",
    "image_url": null
  }
}

Update an entity

When you update an entity, Paddle returns a single data object with a copy of the updated entity if successful.

For example:

{
  "name": "Professional"
}

{
  "data": {
    "id": "pro_71jbvv7LfRKYp19gtRLtkn"
    "name": "Professional",
    "status": "active",
    "description": "Everything in Basic, plus advanced marketing automation and reporting.",
    "tax_category": "saas",
    "image_url": "https://cdn.paddle.com/images/pro_71jbvv7LfRKYp19gtRLtkn.png"
  }
}