exoapi_stripe v0.1.4

View Source ExOAPI.Stripe.SDK.Subscriptions (exoapi_stripe v0.1.4)

Link to this section Summary

Types

get_subscriptions_opts()
get_subscriptions_search_opts()
get_subscriptions_subscription_exposed_id_opts()

Functions

delete_subscriptions_subscription_exposed_id(client, body, subscription_exposed_id)

description: <p>Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.</p>

delete_subscriptions_subscription_exposed_id_discount(client, body, subscription_exposed_id)

description: <p>Removes the currently applied discount on a subscription.</p>

get_subscriptions(client, opts \\ [])

description: <p>By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify <code>status=canceled</code>.</p>

get_subscriptions_search(client, query, opts \\ [])

description: <p>Search for subscriptions you’ve previously created using Stripe’s <a href="/docs/search#search-query-language">Search Query Language</a>. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.</p>

get_subscriptions_subscription_exposed_id(client, subscription_exposed_id, opts \\ [])

description: <p>Retrieves the subscription with the given ID.</p>

post_subscriptions(client, body)

description: <p>Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.</p>

post_subscriptions_subscription_exposed_id(client, body, subscription_exposed_id)

description: <p>Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the <a href="#upcoming_invoice">upcoming invoice</a> endpoint.</p>

Link to this section Types

Link to this type

get_subscriptions_opts()

View Source 
@type get_subscriptions_opts() ::
  {:test_clock, String.t()}
  | {:status, String.t()}
  | {:starting_after, String.t()}
  | {:price, String.t()}
  | {:limit, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}
  | {:customer, String.t()}
  | {:current_period_start, String.t()}
  | {:current_period_end, String.t()}
  | {:created, String.t()}
  | {:collection_method, String.t()}
Link to this type

get_subscriptions_search_opts()

View Source 
@type get_subscriptions_search_opts() ::
  {:page, String.t()} | {:limit, String.t()} | {:expand, String.t()}
Link to this type

get_subscriptions_subscription_exposed_id_opts()

View Source 
@type get_subscriptions_subscription_exposed_id_opts() :: {:expand, String.t()}

Link to this section Functions

Link to this function

delete_subscriptions_subscription_exposed_id(client, body, subscription_exposed_id)

View Source 
@spec delete_subscriptions_subscription_exposed_id(
  client :: ExOAPI.Client.t(),
  body ::
    %{prorate: boolean(), invoice_now: boolean(), expand: [String.t()]} | map(),
  subscription_exposed_id :: String.t()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.Subscription.t()
   | map()}
  | {:error, any()}

description: <p>Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.</p>

Note, however, that any pending invoice items that you’ve created will still be charged for at the end of the period, unless manually deleted. If you’ve set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed.

By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

Link to this function

delete_subscriptions_subscription_exposed_id_discount(client, body, subscription_exposed_id)

View Source 
@spec delete_subscriptions_subscription_exposed_id_discount(
  client :: ExOAPI.Client.t(),
  body :: %{} | map(),
  subscription_exposed_id :: String.t()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.DeletedDiscount.t()
   | map()}
  | {:error, any()}

description: <p>Removes the currently applied discount on a subscription.</p>

Link to this function

get_subscriptions(client, opts \\ [])

View Source 
@spec get_subscriptions(client :: ExOAPI.Client.t(), [get_subscriptions_opts()]) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | %{
       url: String.t(),
       object: String.t() | :list,
       has_more: boolean(),
       data: [ExOAPI.Stripe.Schemas.Subscription.t()]
     }
   | map()}
  | {:error, any()}

description: <p>By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify <code>status=canceled</code>.</p>

Link to this function

get_subscriptions_search(client, query, opts \\ [])

View Source 
@spec get_subscriptions_search(
  client :: ExOAPI.Client.t(),
  query :: String.t(),
  [get_subscriptions_search_opts()]
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | %{
       url: String.t(),
       total_count: integer(),
       object: String.t() | :search_result,
       next_page: String.t(),
       has_more: boolean(),
       data: [ExOAPI.Stripe.Schemas.Subscription.t()]
     }
   | map()}
  | {:error, any()}

description: <p>Search for subscriptions you’ve previously created using Stripe’s <a href="/docs/search#search-query-language">Search Query Language</a>. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.</p>

Link to this function

get_subscriptions_subscription_exposed_id(client, subscription_exposed_id, opts \\ [])

View Source 
@spec get_subscriptions_subscription_exposed_id(
  client :: ExOAPI.Client.t(),
  subscription_exposed_id :: String.t(),
  [get_subscriptions_subscription_exposed_id_opts()]
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.Subscription.t()
   | map()}
  | {:error, any()}

description: <p>Retrieves the subscription with the given ID.</p>

Link to this function

post_subscriptions(client, body)

View Source 
@spec post_subscriptions(
  client :: ExOAPI.Client.t(),
  body ::
    %{
      trial_period_days: integer(),
      trial_from_plan: boolean(),
      trial_end: integer() | String.t() | :now,
      transfer_data: %{destination: String.t(), amount_percent: number()},
      proration_behavior:
        String.t() | :always_invoice | :create_prorations | :none,
      promotion_code: String.t(),
      pending_invoice_item_interval:
        String.t()
        | %{
            interval_count: integer(),
            interval: String.t() | :day | :month | :week | :year
          },
      payment_settings: %{
        payment_method_types:
          String.t()
          | [
              String.t()
              | :ach_credit_transfer
              | :ach_debit
              | :acss_debit
              | :au_becs_debit
              | :bacs_debit
              | :bancontact
              | :boleto
              | :card
              | :customer_balance
              | :fpx
              | :giropay
              | :grabpay
              | :ideal
              | :konbini
              | :paynow
              | :sepa_debit
              | :sofort
              | :us_bank_account
              | :wechat_pay
            ],
        payment_method_options: %{
          us_bank_account:
            String.t()
            | %{
                verification_method:
                  String.t() | :automatic | :instant | :microdeposits
              },
          konbini: String.t() | %{},
          customer_balance:
            String.t()
            | %{funding_type: String.t(), bank_transfer: %{type: String.t()}},
          card:
            String.t()
            | %{
                request_three_d_secure: String.t() | :any | :automatic,
                mandate_options: %{
                  description: String.t(),
                  amount_type: String.t() | :fixed | :maximum,
                  amount: integer()
                }
              },
          bancontact:
            String.t()
            | %{preferred_language: String.t() | :de | :en | :fr | :nl},
          acss_debit:
            String.t()
            | %{
                verification_method:
                  String.t() | :automatic | :instant | :microdeposits,
                mandate_options: %{
                  transaction_type: String.t() | :business | :personal
                }
              }
        }
      },
      payment_behavior:
        String.t()
        | :allow_incomplete
        | :default_incomplete
        | :error_if_incomplete
        | :pending_if_incomplete,
      off_session: boolean(),
      metadata: String.t() | map(),
      items: [
        %{
          tax_rates: String.t() | [String.t()],
          quantity: integer(),
          price_data: %{
            unit_amount_decimal: String.t(),
            unit_amount: integer(),
            tax_behavior: String.t() | :exclusive | :inclusive | :unspecified,
            recurring: %{
              interval_count: integer(),
              interval: String.t() | :day | :month | :week | :year
            },
            product: String.t(),
            currency: String.t()
          },
          price: String.t(),
          metadata: map(),
          billing_thresholds: String.t() | %{usage_gte: integer()}
        }
      ],
      expand: [String.t()],
      default_tax_rates: String.t() | [String.t()],
      default_source: String.t(),
      default_payment_method: String.t(),
      days_until_due: integer(),
      customer: String.t(),
      coupon: String.t(),
      collection_method: String.t() | :charge_automatically | :send_invoice,
      cancel_at_period_end: boolean(),
      cancel_at: integer(),
      billing_thresholds:
        String.t()
        | %{reset_billing_cycle_anchor: boolean(), amount_gte: integer()},
      billing_cycle_anchor: integer(),
      backdate_start_date: integer(),
      automatic_tax: %{enabled: boolean()},
      application_fee_percent: number(),
      add_invoice_items: [
        %{
          tax_rates: String.t() | [String.t()],
          quantity: integer(),
          price_data: %{
            unit_amount_decimal: String.t(),
            unit_amount: integer(),
            tax_behavior: String.t() | :exclusive | :inclusive | :unspecified,
            product: String.t(),
            currency: String.t()
          },
          price: String.t()
        }
      ]
    }
    | map()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.Subscription.t()
   | map()}
  | {:error, any()}

description: <p>Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.</p>

When you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request.The payment_behavior parameter determines the exact behavior of the initial payment.

To start subscriptions where the first invoice always begins in a draft status, use subscription schedules instead.Schedules provide the flexibility to model more complex billing configurations that change over time.

Link to this function

post_subscriptions_subscription_exposed_id(client, body, subscription_exposed_id)

View Source 
@spec post_subscriptions_subscription_exposed_id(
  client :: ExOAPI.Client.t(),
  body ::
    %{
      trial_from_plan: boolean(),
      trial_end: integer() | String.t() | :now,
      transfer_data:
        String.t() | %{destination: String.t(), amount_percent: number()},
      proration_date: integer(),
      proration_behavior:
        String.t() | :always_invoice | :create_prorations | :none,
      promotion_code: String.t(),
      pending_invoice_item_interval:
        String.t()
        | %{
            interval_count: integer(),
            interval: String.t() | :day | :month | :week | :year
          },
      payment_settings: %{
        payment_method_types:
          String.t()
          | [
              String.t()
              | :ach_credit_transfer
              | :ach_debit
              | :acss_debit
              | :au_becs_debit
              | :bacs_debit
              | :bancontact
              | :boleto
              | :card
              | :customer_balance
              | :fpx
              | :giropay
              | :grabpay
              | :ideal
              | :konbini
              | :paynow
              | :sepa_debit
              | :sofort
              | :us_bank_account
              | :wechat_pay
            ],
        payment_method_options: %{
          us_bank_account:
            String.t()
            | %{
                verification_method:
                  String.t() | :automatic | :instant | :microdeposits
              },
          konbini: String.t() | %{},
          customer_balance:
            String.t()
            | %{funding_type: String.t(), bank_transfer: %{type: String.t()}},
          card:
            String.t()
            | %{
                request_three_d_secure: String.t() | :any | :automatic,
                mandate_options: %{
                  description: String.t(),
                  amount_type: String.t() | :fixed | :maximum,
                  amount: integer()
                }
              },
          bancontact:
            String.t()
            | %{preferred_language: String.t() | :de | :en | :fr | :nl},
          acss_debit:
            String.t()
            | %{
                verification_method:
                  String.t() | :automatic | :instant | :microdeposits,
                mandate_options: %{
                  transaction_type: String.t() | :business | :personal
                }
              }
        }
      },
      payment_behavior:
        String.t()
        | :allow_incomplete
        | :default_incomplete
        | :error_if_incomplete
        | :pending_if_incomplete,
      pause_collection:
        String.t()
        | %{
            resumes_at: integer(),
            behavior: String.t() | :keep_as_draft | :mark_uncollectible | :void
          },
      off_session: boolean(),
      metadata: String.t() | map(),
      items: [
        %{
          tax_rates: String.t() | [String.t()],
          quantity: integer(),
          price_data: %{
            unit_amount_decimal: String.t(),
            unit_amount: integer(),
            tax_behavior: String.t() | :exclusive | :inclusive | :unspecified,
            recurring: %{
              interval_count: integer(),
              interval: String.t() | :day | :month | :week | :year
            },
            product: String.t(),
            currency: String.t()
          },
          price: String.t(),
          metadata: String.t() | map(),
          id: String.t(),
          deleted: boolean(),
          clear_usage: boolean(),
          billing_thresholds: String.t() | %{usage_gte: integer()}
        }
      ],
      expand: [String.t()],
      default_tax_rates: String.t() | [String.t()],
      default_source: String.t(),
      default_payment_method: String.t(),
      days_until_due: integer(),
      coupon: String.t(),
      collection_method: String.t() | :charge_automatically | :send_invoice,
      cancel_at_period_end: boolean(),
      cancel_at: String.t() | integer(),
      billing_thresholds:
        String.t()
        | %{reset_billing_cycle_anchor: boolean(), amount_gte: integer()},
      billing_cycle_anchor: String.t() | :now | :unchanged,
      automatic_tax: %{enabled: boolean()},
      application_fee_percent: number(),
      add_invoice_items: [
        %{
          tax_rates: String.t() | [String.t()],
          quantity: integer(),
          price_data: %{
            unit_amount_decimal: String.t(),
            unit_amount: integer(),
            tax_behavior: String.t() | :exclusive | :inclusive | :unspecified,
            product: String.t(),
            currency: String.t()
          },
          price: String.t()
        }
      ]
    }
    | map(),
  subscription_exposed_id :: String.t()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.Subscription.t()
   | map()}
  | {:error, any()}

description: <p>Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the <a href="#upcoming_invoice">upcoming invoice</a> endpoint.</p>