sfgboxapi

CreateSubscribeCustomer

The following routes are available for this service:
POST	/create-customer

**CreateSubscribeCustomer** Parameters:
Name	Parameter	Data Type	Required	Description
Email	body	string	No

**StripeCustomer** Parameters:
Name	Parameter	Data Type	Required
AccountBalance	form	int	No
BusinessVatId	form	string	No
Created	form	DateTime?	No
DefaultSource	form	string	No
Delinquent	form	bool?	No
Description	form	string	No
Discount	form	StripeDiscount	No
Email	form	string	No
InvoicePrefix	form	string	No
Livemode	form	bool	No
Metadata	form	Dictionary<string, string>	No
Shipping	form	StripeShipping	No
Sources	form	StripeCollection<StripeCard>	No
Subscriptions	form	StripeCollection<StripeSubscription>	No
Deleted	form	bool	No
Currency	form	string	No

**StripeId** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	string	No

**StripeObject** Parameters:
Name	Parameter	Data Type	Required	Description
Object	form	StripeType?	No

**StripeType** Enum:
unknown
account
card
charge
coupon
customer
discount
dispute
event
invoiceitem
invoice
line_item
plan
subscription
token
transfer
list
product

**StripeDiscount** Parameters:
Name	Parameter	Data Type	Required
Customer	form	string	No
Coupon	form	StripeCoupon	No
Start	form	DateTime?	No
End	form	DateTime?	No

**StripeCoupon** Parameters:
Name	Parameter	Data Type	Required
AmountOff	form	int?	No
Created	form	DateTime?	No
Currency	form	string	No
Duration	form	StripeCouponDuration	No
DurationInMonths	form	int?	No
Livemode	form	bool	No
MaxRedemptions	form	int?	No
Metadata	form	Dictionary<string, string>	No
PercentOff	form	int?	No
RedeemBy	form	DateTime?	No
TimesRedeemed	form	int	No
Valid	form	bool	No

**StripeCouponDuration** Enum:
forever
once
repeating

**StripeShipping** Parameters:
Name	Parameter	Data Type	Required
Address	form	StripeAddress	No
Name	form	string	No
Phone	form	string	No

**StripeAddress** Parameters:
Name	Parameter	Data Type	Required
City	form	string	No
Country	form	string	No
Line1	form	string	No
Line2	form	string	No
PostalCode	form	string	No
State	form	string	No

**StripeCollection<T>** Parameters:
Name	Parameter	Data Type	Required
Url	form	string	No
TotalCount	form	int	No
HasMore	form	bool?	No
Data	form	List<T>	No

**StripeCard** Parameters:
Name	Parameter	Data Type	Required
Brand	form	string	No
Number	form	string	No
Last4	form	string	No
DynamicLast4	form	string	No
ExpMonth	form	int	No
ExpYear	form	int	No
Cvc	form	string	No
Name	form	string	No
AddressCity	form	string	No
AddressCountry	form	string	No
AddressLine1	form	string	No
AddressLine2	form	string	No
AddressState	form	string	No
AddressZip	form	string	No
CvcCheck	form	StripeCvcCheck?	No
AddressLine1Check	form	string	No
AddressZipCheck	form	string	No
Funding	form	string	No
Fingerprint	form	string	No
Customer	form	string	No
Country	form	string	No

**StripeCvcCheck** Enum:
Unknown
Pass
Fail
Unchecked

**StripeSubscription** Parameters:
Name	Parameter	Data Type	Required
CurrentPeriodEnd	form	DateTime?	No
Status	form	StripeSubscriptionStatus	No
Plan	form	StripePlan	No
CurrentPeriodStart	form	DateTime?	No
Start	form	DateTime?	No
TrialStart	form	DateTime?	No
CancelAtPeriodEnd	form	bool?	No
TrialEnd	form	DateTime?	No
CanceledAt	form	DateTime?	No
EndedAt	form	DateTime?	No
Customer	form	string	No
Quantity	form	int	No

**StripeSubscriptionStatus** Enum:
Unknown
Trialing
Active
PastDue
Canceled
Unpaid

**StripePlan** Parameters:
Name	Parameter	Data Type	Required
Amount	form	int	No
Created	form	DateTime?	No
Currency	form	string	No
Interval	form	StripePlanInterval	No
IntervalCount	form	int?	No
Livemode	form	bool	No
Metadata	form	Dictionary<string, string>	No
Nickname	form	string	No
Product	form	string	No
TrialPeriodDays	form	int?	No

**StripePlanInterval** Enum:
month
year

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /create-customer HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateSubscribeCustomer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <Email>String</Email>
</CreateSubscribeCustomer>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<StripeCustomer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ServiceStack.Stripe.Types">
  <Object>unknown</Object>
  <Id>String</Id>
  <AccountBalance>0</AccountBalance>
  <BusinessVatId>String</BusinessVatId>
  <Created>0001-01-01T00:00:00</Created>
  <Currency>String</Currency>
  <DefaultSource>String</DefaultSource>
  <Deleted>false</Deleted>
  <Delinquent>false</Delinquent>
  <Description>String</Description>
  <Discount>
    <Object>unknown</Object>
    <Id>String</Id>
    <Coupon>
      <Object>unknown</Object>
      <Id>String</Id>
      <AmountOff>0</AmountOff>
      <Created>0001-01-01T00:00:00</Created>
      <Currency>String</Currency>
      <Duration>forever</Duration>
      <DurationInMonths>0</DurationInMonths>
      <Livemode>false</Livemode>
      <MaxRedemptions>0</MaxRedemptions>
      <Metadata xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Metadata>
      <PercentOff>0</PercentOff>
      <RedeemBy>0001-01-01T00:00:00</RedeemBy>
      <TimesRedeemed>0</TimesRedeemed>
      <Valid>false</Valid>
    </Coupon>
    <Customer>String</Customer>
    <End>0001-01-01T00:00:00</End>
    <Start>0001-01-01T00:00:00</Start>
  </Discount>
  <Email>String</Email>
  <InvoicePrefix>String</InvoicePrefix>
  <Livemode>false</Livemode>
  <Metadata xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Metadata>
  <Shipping>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/ServiceStack.Stripe">
      <d3p1:City>String</d3p1:City>
      <d3p1:Country>String</d3p1:Country>
      <d3p1:Line1>String</d3p1:Line1>
      <d3p1:Line2>String</d3p1:Line2>
      <d3p1:PostalCode>String</d3p1:PostalCode>
      <d3p1:State>String</d3p1:State>
    </Address>
    <Name>String</Name>
    <Phone>String</Phone>
  </Shipping>
  <Sources>
    <Object>unknown</Object>
    <Id>String</Id>
    <Data>
      <StripeCard>
        <Object>unknown</Object>
        <Id>String</Id>
        <AddressCity>String</AddressCity>
        <AddressCountry>String</AddressCountry>
        <AddressLine1>String</AddressLine1>
        <AddressLine1Check>String</AddressLine1Check>
        <AddressLine2>String</AddressLine2>
        <AddressState>String</AddressState>
        <AddressZip>String</AddressZip>
        <AddressZipCheck>String</AddressZipCheck>
        <Brand>String</Brand>
        <Country>String</Country>
        <Customer>String</Customer>
        <Cvc>String</Cvc>
        <CvcCheck>Unknown</CvcCheck>
        <DynamicLast4>String</DynamicLast4>
        <ExpMonth>0</ExpMonth>
        <ExpYear>0</ExpYear>
        <Fingerprint>String</Fingerprint>
        <Funding>String</Funding>
        <Last4>String</Last4>
        <Name>String</Name>
        <Number>String</Number>
      </StripeCard>
    </Data>
    <HasMore>false</HasMore>
    <TotalCount>0</TotalCount>
    <Url>String</Url>
  </Sources>
  <Subscriptions>
    <Object>unknown</Object>
    <Id>String</Id>
    <Data>
      <StripeSubscription>
        <Object>unknown</Object>
        <Id>String</Id>
        <CancelAtPeriodEnd>false</CancelAtPeriodEnd>
        <CanceledAt>0001-01-01T00:00:00</CanceledAt>
        <CurrentPeriodEnd>0001-01-01T00:00:00</CurrentPeriodEnd>
        <CurrentPeriodStart>0001-01-01T00:00:00</CurrentPeriodStart>
        <Customer>String</Customer>
        <EndedAt>0001-01-01T00:00:00</EndedAt>
        <Plan>
          <Object>unknown</Object>
          <Id>String</Id>
          <Amount>0</Amount>
          <Created>0001-01-01T00:00:00</Created>
          <Currency>String</Currency>
          <Interval>month</Interval>
          <IntervalCount>0</IntervalCount>
          <Livemode>false</Livemode>
          <Metadata xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </Metadata>
          <Nickname>String</Nickname>
          <Product>String</Product>
          <TrialPeriodDays>0</TrialPeriodDays>
        </Plan>
        <Quantity>0</Quantity>
        <Start>0001-01-01T00:00:00</Start>
        <Status>Unknown</Status>
        <TrialEnd>0001-01-01T00:00:00</TrialEnd>
        <TrialStart>0001-01-01T00:00:00</TrialStart>
      </StripeSubscription>
    </Data>
    <HasMore>false</HasMore>
    <TotalCount>0</TotalCount>
    <Url>String</Url>
  </Subscriptions>
</StripeCustomer>