Billhighway Cloud API

<back to all web services

SubscriptionCreateRq

export class SubscriberFormField
{
    public Name?: string;
    public Value?: string;

    public constructor(init?: Partial<SubscriberFormField>) { (Object as any).assign(this, init); }
}

export class SubscriberFormData
{
    public FormTemplateID?: number;
    public SignupTypeID?: number;
    public FormFields?: SubscriberFormField[];

    public constructor(init?: Partial<SubscriberFormData>) { (Object as any).assign(this, init); }
}

export class SubscriptionInformation
{
    public FrequencyID?: number;
    public SubscriptionInvoiceID?: number;
    public AutoRenew?: boolean;
    public HasAgreedToTerms?: boolean;
    public ClientSubscriberId?: string;
    public RenewedMemberSubscriptionInvID?: number;

    public constructor(init?: Partial<SubscriptionInformation>) { (Object as any).assign(this, init); }
}

export class ClientVerification
{
    public Provider?: string;
    public VerificationCode?: string;

    public constructor(init?: Partial<ClientVerification>) { (Object as any).assign(this, init); }
}

export class CcPaymentInformation
{
    public CardNumber?: string;
    public Cvv?: string;
    public ExpMonth?: number;
    public ExpYear?: number;
    public CardholderName?: string;
    public Country?: string;
    public BillingAddress?: string;
    public Address1?: string;
    public Address2?: string;
    public City?: string;
    public StateProvince?: string;
    public PostalCode?: string;

    public constructor(init?: Partial<CcPaymentInformation>) { (Object as any).assign(this, init); }
}

export class AchPaymentInformation
{
    public AccountHolderName?: string;
    public CheckNumber?: string;
    public RoutingNumber?: string;
    public AccountNumber?: string;
    public AccountType?: string;

    public constructor(init?: Partial<AchPaymentInformation>) { (Object as any).assign(this, init); }
}

export class CampaignInformation
{
    public CampaignId?: number;
    public CampaignName?: string;
    public Amount?: number;
    public ChapPayID?: string;

    public constructor(init?: Partial<CampaignInformation>) { (Object as any).assign(this, init); }
}

export class BillMeLaterInformation
{
    public IsBillMeLaterPayment?: boolean;
    public IsBillMeLaterSubscription?: boolean;
    public MemberSubscriptionInvId?: number;
    public Campaigns?: CampaignInformation[];

    public constructor(init?: Partial<BillMeLaterInformation>) { (Object as any).assign(this, init); }
}

export class SubscriptionCreateRq
{
    public NatID?: number;
    public GroupID?: number;
    public ClientGroupID?: string;
    public UserType?: string;
    public UserID?: string;
    public FormData?: SubscriberFormData;
    public SubscriptionInfo?: SubscriptionInformation;
    public VerificationInfo?: ClientVerification;
    public CcPaymentInfo?: CcPaymentInformation;
    public AchPaymentInfo?: AchPaymentInformation;
    public BillMeLater?: BillMeLaterInformation;
    public Campaigns?: CampaignInformation[];

    public constructor(init?: Partial<SubscriptionCreateRq>) { (Object as any).assign(this, init); }
}

export class SubscriptionCreateRs
{
    public IsSuccess?: boolean;
    public UniqueId?: string;
    public CreatedDateTime?: string;
    public ClientId?: number;
    public BillhighwayUserId?: number;
    public ConfirmationNumber?: string;
    public PaymentConfirmationNumber?: number;
    public SubscriptionConfirmationNumber?: number;
    public ErrorCode?: string;
    public Message?: string;
    public FriendlyMessage?: string;

    public constructor(init?: Partial<SubscriptionCreateRs>) { (Object as any).assign(this, init); }
}

TypeScript SubscriptionCreateRq DTOs

POST /signup/api/nat/{natID}/group/{groupID}/subscription HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"NatID":0,"GroupID":0,"ClientGroupID":"String","UserType":"String","UserID":"String","FormData":{"FormTemplateID":0,"SignupTypeID":0,"FormFields":[{"FormTemplateFieldID":0,"Name":"String","Value":"String"}]},"SubscriptionInfo":{"FrequencyID":0,"SubscriptionInvoiceID":0,"AutoRenew":false,"HasAgreedToTerms":false,"ClientSubscriberId":"String","RenewedMemberSubscriptionInvID":0},"VerificationInfo":{"Provider":"String","VerificationCode":"String"},"CcPaymentInfo":{"CardNumber":"String","Cvv":"String","ExpMonth":0,"ExpYear":0,"CardholderName":"String","Country":"String","BillingAddress":"String","Address1":"String","Address2":"String","City":"String","StateProvince":"String","PostalCode":"String"},"AchPaymentInfo":{"AccountHolderName":"String","CheckNumber":"String","RoutingNumber":"String","AccountNumber":"String","AccountType":"String"},"BillMeLater":{"IsBillMeLaterPayment":false,"IsBillMeLaterSubscription":false,"MemberSubscriptionInvId":0,"Campaigns":[{"CampaignId":0,"CampaignName":"String","Amount":0,"ChapPayID":"String"}]},"Campaigns":[{"CampaignId":0,"CampaignName":"String","Amount":0,"ChapPayID":"String"}]}

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

{"IsSuccess":false,"UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"BillhighwayUserId":0,"ConfirmationNumber":"String","PaymentConfirmationNumber":0,"SubscriptionConfirmationNumber":0,"ErrorCode":"String","Message":"String","FriendlyMessage":"String"}