Create Credit Entitlement

Create a new credit entitlement for the authenticated business.

Each entitlement defines how credits behave in terms of expiration, rollover, and overage.

Business Logic

• A unique ID with prefix cde_ is automatically generated for the entitlement
• Created and updated timestamps are automatically set
• Currency is required when price_per_unit is set
• price_per_unit is required when overage_enabled is true
• rollover_timeframe_count and rollover_timeframe_interval must both be set or both be null

Request

use dodopayments_rust::{
    models::CreateCreditEntitlementRequest, to_pretty_json, DodoPaymentsClientBuilder,
};
#[tokio::main]

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let api_key = std::env::var("DODO_API_KEY")?;

    let client = DodoPaymentsClientBuilder::new()
        .bearer_token(&api_key)
        .enviroment("test_mode")
        .build()?;

    let resp = client
        .credit_entitlements()
        .create()
        .body(CreateCreditEntitlementRequest {
            name: "Basic Credits".to_string(),
            description: Some("Monthly credit allocation".to_string()),
            unit: "credits".to_string(),
            price_per_unit: Some("1.00".to_string()),
            ..Default::default()
        })
        .send()
        .await?;

    println!("{}", to_pretty_json(&resp)?);

    Ok(())
}

Body

Responses

201 Status

Credit entitlement created successfully

422 Status

Invalid Request Object or Parameters

500 Status

Something went wrong :(