---
agentTools:
  projectIndex: https://sendinblue.readme.io/llms.txt
---

# Create balance order

Returns created order

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "contact": {
      "email": "contact@brevo.com",
      "name": "Brevo Support",
      "url": "https://account.brevo.com/support"
    },
    "description": "Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :\n  - Manage your campaigns and get the statistics\n  - Manage your contacts\n  - Send transactional Emails and SMS\n  - and much more...\n\nYou can download our wrappers at https://github.com/orgs/brevo\n**Possible responses**\n  | Code | Message |\n  | :-------------: | ------------- |\n  | 200  | OK. Successful Request  |\n  | 201  | OK. Successful Creation |\n  | 202  | OK. Request accepted |\n  | 204  | OK. Successful Update/Deletion  |\n  | 400  | Error. Bad Request  |\n  | 401  | Error. Authentication Needed  |\n  | 402  | Error. Not enough credit, plan upgrade needed  |\n  | 403  | Error. Permission denied  |\n  | 404  | Error. Object does not exist |\n  | 405  | Error. Method not allowed  |\n  | 406  | Error. Not Acceptable  |\n  | 422  | Error. Unprocessable Entity |\n",
    "license": {
      "name": "MIT",
      "url": "http://opensource.org/licenses/MIT"
    },
    "title": "Brevo API",
    "version": "3.0.0"
  },
  "servers": [
    {
      "url": "https://api.brevo.com/v3"
    }
  ],
  "security": [
    {
      "api-key": []
    },
    {
      "partner-key": []
    }
  ],
  "paths": {
    "/loyalty/balance/programs/{pid}/create-order": {
      "post": {
        "description": "Returns created order",
        "operationId": "createBalanceOrder",
        "parameters": [
          {
            "description": "Loyalty Program Id",
            "in": "path",
            "name": "pid",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "Payload for creating an order linked to a balance definition.",
                "properties": {
                  "amount": {
                    "description": "Order amount (must be non-zero).",
                    "type": "number"
                  },
                  "balanceDefinitionId": {
                    "description": "Unique identifier (UUID) of the associated balance definition.",
                    "type": "string"
                  },
                  "contactId": {
                    "description": "Unique identifier of the contact placing the order (must be ≥ 1).",
                    "minimum": 1,
                    "type": "integer"
                  },
                  "dueAt": {
                    "description": "RFC3339 timestamp specifying when the order is due.",
                    "type": "string"
                  },
                  "expiresAt": {
                    "description": "Optional RFC3339 timestamp defining order expiration.",
                    "type": "string"
                  },
                  "meta": {
                    "additionalProperties": true,
                    "description": "Optional metadata associated with the order.",
                    "type": "object"
                  },
                  "source": {
                    "description": "Specifies the origin of the order (`engine` or `user`).",
                    "type": "string"
                  }
                },
                "required": [
                  "amount",
                  "balanceDefinitionId",
                  "contactId",
                  "dueAt",
                  "source"
                ],
                "type": "object"
              }
            }
          },
          "description": "Order Payload",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "Represents an order linked to a balance definition, including amount, due date, and transaction details.",
                  "properties": {
                    "amount": {
                      "description": "Order amount (must not be zero).",
                      "type": "number"
                    },
                    "balanceDefinitionId": {
                      "description": "Optional unique identifier (UUID) of the associated balance definition.",
                      "type": "string"
                    },
                    "contactId": {
                      "description": "Unique identifier of the contact placing the order (must be ≥ 1).",
                      "minimum": 1,
                      "type": "integer"
                    },
                    "createdAt": {
                      "description": "RFC3339 timestamp indicating when the order was created.",
                      "type": "string"
                    },
                    "dueAt": {
                      "description": "RFC3339 timestamp specifying when the order is due in the future.",
                      "type": "string"
                    },
                    "expiresAt": {
                      "description": "Optional RFC3339 timestamp defining order expiration in the future.",
                      "type": "string"
                    },
                    "id": {
                      "description": "Unique identifier for the balance order.",
                      "type": "string"
                    },
                    "loyaltyProgramId": {
                      "description": "Unique identifier of the loyalty program associated with the order.",
                      "type": "string"
                    },
                    "meta": {
                      "additionalProperties": true,
                      "description": "Optional metadata associated with the order.",
                      "type": "object"
                    },
                    "processedAt": {
                      "description": "Optional RFC3339 timestamp indicating when the order was processed.",
                      "type": "string"
                    },
                    "transactionid": {
                      "description": "Optional reference to the associated transaction ID.",
                      "type": "string"
                    },
                    "updatedAt": {
                      "description": "RFC3339 timestamp indicating the last update to the order.",
                      "type": "string"
                    }
                  },
                  "required": [
                    "amount",
                    "contactId",
                    "createdAt",
                    "dueAt",
                    "loyaltyProgramId",
                    "updatedAt"
                  ],
                  "type": "object"
                }
              }
            },
            "description": "Successful creation of order"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/errorModel"
                }
              }
            },
            "description": "Request Authentication Failed"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/errorModel"
                }
              }
            },
            "description": "Cannot Authenticate Request"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/errorModel"
                }
              }
            },
            "description": "Validation errors"
          },
          "500": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/errorModel"
                }
              }
            },
            "description": "Internal error occurred"
          }
        },
        "summary": "Create balance order",
        "tags": [
          "Balance"
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "api-key": {
        "description": "The API key should be passed in the request headers as `api-key` for authentication.",
        "in": "header",
        "name": "api-key",
        "type": "apiKey"
      },
      "partner-key": {
        "description": "The partner key should be passed in the request headers as `partner-key` along with `api-key` pair for successful authentication of partner (Optional).",
        "in": "header",
        "name": "partner-key",
        "type": "apiKey"
      }
    },
    "schemas": {
      "errorModel": {
        "properties": {
          "code": {
            "description": "Error code displayed in case of a failure",
            "example": "method_not_allowed",
            "type": "string"
          },
          "message": {
            "description": "Readable message associated to the failure",
            "example": "POST Method is not allowed on this path",
            "type": "string"
          }
        },
        "required": [
          "message"
        ],
        "type": "object"
      }
    }
  },
  "x-samples-languages": [
    "curl"
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 91,
      "1": 104,
      "2": 180,
      "3": 205,
      "4": 240,
      "5": 82,
      "6": 207,
      "7": 0,
      "8": 3,
      "9": 36,
      "10": 63,
      "11": 142
    }
  }
}
```