Struct CreateSubscriptionRequest 

pub struct CreateSubscriptionRequest<'a> {
    pub customer_id: CustomerId<'a>,
    pub plan_id: PlanId<'a>,
    pub start_date: Option<OffsetDateTime>,
    pub external_marketplace: Option<SubscriptionExternalMarketplaceRequest<'a>>,
    pub align_billing_with_subscription_start_date: Option<bool>,
    pub minimum_amount: Option<&'a str>,
    pub net_terms: Option<i64>,
    pub auto_collection: Option<bool>,
    pub default_invoice_memo: Option<&'a str>,
    pub idempotency_key: Option<&'a str>,
}

An Orb subscription.

Fields

customer_id: CustomerId<'a>

An optional user-defined ID for this customer resource, used throughout the system as an alias for this customer.

plan_id: PlanId<'a>

The plan that the customer should be subscribed to.

The plan determines the pricing and the cadence of the subscription.

start_date: Option<OffsetDateTime>

The date at which Orb should start billing for the subscription, localized ot the customer’s timezone.

If None, defaults to the current date in the customer’s timezone.

external_marketplace: Option<SubscriptionExternalMarketplaceRequest<'a>>

The name of the external marketplace that the subscription is attached to.

align_billing_with_subscription_start_date: Option<bool>

Whether to align billing periods with the subscription’s start date.

If None, the value is determined by the plan configuration.

minimum_amount: Option<&'a str>

The subscription’s override minimum amount for the plan.

net_terms: Option<i64>

The subscription’s override minimum amount for the plan.

auto_collection: Option<bool>

Determines whether issued invoices for this subscription will automatically be charged with the saved payment method on the due date.

If None, the value is determined by the plan configuration.

default_invoice_memo: Option<&'a str>

Determines the default memo on this subscription’s invoices.

If None, the value is determined by the plan configuration.

idempotency_key: Option<&'a str>

An idempotency key can ensure that if the same request comes in multiple times in a 48-hour period, only one makes changes.

Trait Implementations

impl<'a> Clone for CreateSubscriptionRequest<'a>

fn clone(&self) -> CreateSubscriptionRequest<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for CreateSubscriptionRequest<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Default for CreateSubscriptionRequest<'a>

fn default() -> CreateSubscriptionRequest<'a>

Returns the “default value” for a type.

impl<'a> Hash for CreateSubscriptionRequest<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq for CreateSubscriptionRequest<'a>

fn eq(&self, other: &CreateSubscriptionRequest<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Serialize for CreateSubscriptionRequest<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Eq for CreateSubscriptionRequest<'a>

impl<'a> StructuralPartialEq for CreateSubscriptionRequest<'a>