POST api/Emails?stripeSecretKey={stripeSecretKey}&customerId={customerId}&planId={planId}&coupon={coupon}&email={email}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
stripeSecretKey

string

Required

customerId

string

Required

planId

string

Required

coupon

string

Required

email

string

Required

Body Parameters

None.

Response Information

Resource Description

Subscription
NameDescriptionTypeAdditional information
id

string

None.

object

string

None.

application_fee_percent

decimal number

None.

billing_cycle_anchor

date

None.

billing_thresholds

SubscriptionBillingThresholds

None.

cancel_at

date

None.

cancel_at_period_end

boolean

None.

canceled_at

date

None.

collection_method

string

None.

created

date

None.

current_period_end

date

None.

current_period_start

date

None.

days_until_due

integer

None.

default_tax_rates

Collection of TaxRate

None.

discount

Discount

None.

ended_at

date

None.

items

Collection of SubscriptionItem

None.

livemode

boolean

None.

metadata

Dictionary of string [key] and string [value]

None.

next_pending_invoice_item_invoice

date

None.

pause_collection

SubscriptionPauseCollection

None.

pending_invoice_item_interval

SubscriptionPendingInvoiceItemInterval

None.

pending_update

SubscriptionPendingUpdate

None.

plan

Plan

None.

quantity

integer

None.

start_date

date

None.

status

string

None.

tax_percent

decimal number

None.

transfer_data

SubscriptionTransferData

None.

trial_end

date

None.

trial_start

date

None.

Response Formats

application/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected for property 'discount' with type 'Stripe.Discount'. Path 'customer.discount.customer'.

text/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected for property 'discount' with type 'Stripe.Discount'. Path 'customer.discount.customer'.

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'Stripe.StripeResponse' cannot be serialized. Consider marking it with the DataContractAttribute attribute, and marking all of its members you want serialized with the DataMemberAttribute attribute. If the type is a collection, consider marking it with the CollectionDataContractAttribute. See the Microsoft .NET Framework documentation for other supported types.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'Stripe.StripeResponse' cannot be serialized. Consider marking it with the DataContractAttribute attribute, and marking all of its members you want serialized with the DataMemberAttribute attribute. If the type is a collection, consider marking it with the CollectionDataContractAttribute. See the Microsoft .NET Framework documentation for other supported types.