stripekit::Subscription Struct Reference

A Stripe subscription: a customer's recurring agreement to pay. More...

#include <Models.h>

Public Attributes
std::string	id
	Stripe-assigned subscription identifier.
std::string	customer_id
	Stripe customer identifier owning this subscription.
std::string	status
	Lifecycle status, for example active, trialing, or past_due.
std::int64_t	current_period_start_unix = 0
	Unix timestamp for the current period start.
std::int64_t	current_period_end_unix = 0
	Unix timestamp for the current period end.
bool	cancel_at_period_end = false
	True when cancellation will occur at period end.
bool	livemode = false
	True when the object belongs to a live Stripe account.
std::unordered_map< std::string, std::string >	metadata
	Free-form metadata key/value pairs attached to this subscription.

Detailed Description

A Stripe subscription: a customer's recurring agreement to pay.

status is what decides whether the customer should have access. "active" and "trialing" mean yes; "past_due" means Stripe is retrying a failed payment; "canceled" and "unpaid" mean no.

See also

https://docs.stripe.com/api/subscriptions/object

Definition at line 98 of file Models.h.

Member Data Documentation

id

std::string stripekit::Subscription::id

Stripe-assigned subscription identifier.

Definition at line 100 of file Models.h.

customer_id

std::string stripekit::Subscription::customer_id

Stripe customer identifier owning this subscription.

Definition at line 103 of file Models.h.

status

std::string stripekit::Subscription::status

Lifecycle status, for example active, trialing, or past_due.

Definition at line 106 of file Models.h.

current_period_start_unix

std::int64_t stripekit::Subscription::current_period_start_unix = 0

Unix timestamp for the current period start.

Definition at line 109 of file Models.h.

current_period_end_unix

std::int64_t stripekit::Subscription::current_period_end_unix = 0

Unix timestamp for the current period end.

Definition at line 112 of file Models.h.

cancel_at_period_end

bool stripekit::Subscription::cancel_at_period_end = false

True when cancellation will occur at period end.

Definition at line 115 of file Models.h.

livemode

bool stripekit::Subscription::livemode = false

True when the object belongs to a live Stripe account.

Definition at line 118 of file Models.h.

metadata

std::unordered_map<std::string, std::string> stripekit::Subscription::metadata

Free-form metadata key/value pairs attached to this subscription.

Definition at line 121 of file Models.h.

---

The documentation for this struct was generated from the following file:

• include/StripeKit/Models.h