View Source ExOAPI.Stripe.SDK.SubscriptionSchedules (exoapi_stripe v0.1.1)
Link to this section Summary
Functions
description: <p>Retrieves the list of your subscription schedules.</p>
description: <p>Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.</p>
description: <p>Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.</p>
description: <p>Updates an existing subscription schedule.</p>
description: <p>Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is <code>not_started</code> or <code>active</code>.</p>
description: <p>Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is <code>not_started</code> or <code>active</code>. If the subscription schedule is currently associated with a subscription, releasing it will remove its <code>subscription</code> property and set the subscription’s ID to the <code>released_subscription</code> property.</p>
Link to this section Types
@type get_subscription_schedules_opts() :: {:starting_after, String.t()} | {:scheduled, String.t()} | {:released_at, String.t()} | {:limit, String.t()} | {:expand, String.t()} | {:ending_before, String.t()} | {:customer, String.t()} | {:created, String.t()} | {:completed_at, String.t()} | {:canceled_at, String.t()}
@type get_subscription_schedules_schedule_opts() :: {:expand, String.t()}
Link to this section Functions
@spec get_subscription_schedules(client :: ExOAPI.Client.t(), [ get_subscription_schedules_opts() ]) :: {:ok, any()} | {:error, any()}
description: <p>Retrieves the list of your subscription schedules.</p>
@spec get_subscription_schedules_schedule( client :: ExOAPI.Client.t(), schedule :: String.t(), [get_subscription_schedules_schedule_opts()] ) :: {:ok, any()} | {:error, any()}
description: <p>Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.</p>
@spec post_subscription_schedules(client :: ExOAPI.Client.t(), body :: map()) :: {:ok, any()} | {:error, any()}
description: <p>Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.</p>
@spec post_subscription_schedules_schedule( client :: ExOAPI.Client.t(), body :: map(), schedule :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Updates an existing subscription schedule.</p>
post_subscription_schedules_schedule_cancel(client, body, schedule)
View Source@spec post_subscription_schedules_schedule_cancel( client :: ExOAPI.Client.t(), body :: map(), schedule :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is <code>not_started</code> or <code>active</code>.</p>
post_subscription_schedules_schedule_release(client, body, schedule)
View Source@spec post_subscription_schedules_schedule_release( client :: ExOAPI.Client.t(), body :: map(), schedule :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is <code>not_started</code> or <code>active</code>. If the subscription schedule is currently associated with a subscription, releasing it will remove its <code>subscription</code> property and set the subscription’s ID to the <code>released_subscription</code> property.</p>