Introducing the Better Auth Chargebee plugin: Use it to handle subscriptions, billing, and auth seamlessly.
Chargebeechargebee API

Add schedule

Idempotency Supported

This API is used to schedule exchange rate modification for a manual forex_type currency.

Prerequisites & Constraints

  • Multi-currency pricing must be enabled for your site to schedule a currency exchange-rate change.
  • site-currency-id must reference a manual forex type currency.

Sample Request

Sample Result[JSON]

URL Format

POST https://[site].chargebee.com/api/v2/currencies/{site-currency-id}/add_schedule

Input Parameters

manual_exchange_rate
required, string, max chars=20

This parameter allows you to pass the exchange rate in decimal format. When forex_type is manual you have to set the exchange rate for additional currencies in manual_exchange_rate parameter. A maximum of nine decimal values are allowed to pass in this field.

Constraints
  • manual_exchange_rate must be a valid number greater than zero (e.g. 1.25, 0.5, .5, 100).
  • manual_exchange_rate has more than 9 decimal places; the server silently truncates to 9 decimals. Round the value yourself to avoid surprises.
schedule_at
required, timestamp(UTC) in seconds

Timestamp at which the exchange rate scheduled has to be updated in your site. This timestamp must be a future date.

Constraint
  • schedule_at must be a future timestamp (Unix seconds, UTC). Use a value strictly greater than the current time.

Returns

scheduled_at
required, timestamp(UTC) in seconds
currency
Currency object
Resource object representing currency