Get Credit Entitlement Detail

Retrieve a specific credit entitlement by its ID.

settings for expiration, rollover, and overage policies.

Business Logic

  • Only non-deleted credit entitlements can be retrieved through this
  • The entitlement must belong to the authenticated business (business_id check)
  • Deleted entitlements return a 404 error and must be retrieved via the list with deleted=true

Request

use dodopayments_rust::{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 entitlement_id = "ent_xxxxxxxxxx";

    let resp = client
        .credit_entitlements()
        .id(entitlement_id)
        .retrieve()
        .send()
        .await?;

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

    Ok(())
}

Path Parameters

ParameterTypeDescription
idstringCredit Entitlement ID

Responses

200 Status

FieldTypeDescription
business_idstring
created_atstring
currencyobject
descriptionobject
expires_after_daysobject
idstring
max_rollover_countobject
namestring
overage_behaviorCbbOverageBehaviorControls how overage is handled at billing cycle end.
overage_enabledboolean
overage_limitobject
precisioninteger
price_per_unitobjectPrice per credit unit
rollover_enabledboolean
rollover_percentageobject
rollover_timeframe_countobject
rollover_timeframe_intervalobject
unitstring
updated_atstring

Credit entitlement details

404 Status

Credit entitlement not found

500 Status

Something went wrong :(