models

package
v0.0.0-...-13576d3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 7, 2018 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// BFErrorErrorTypeBFError captures enum value "BFError"
	BFErrorErrorTypeBFError string = "BFError"
	// BFErrorErrorTypeServerError captures enum value "ServerError"
	BFErrorErrorTypeServerError string = "ServerError"
	// BFErrorErrorTypeValidationError captures enum value "ValidationError"
	BFErrorErrorTypeValidationError string = "ValidationError"
	// BFErrorErrorTypeUnserializationException captures enum value "UnserializationException"
	BFErrorErrorTypeUnserializationException string = "UnserializationException"
	// BFErrorErrorTypeOauth captures enum value "Oauth"
	BFErrorErrorTypeOauth string = "Oauth"
	// BFErrorErrorTypePermissionsError captures enum value "PermissionsError"
	BFErrorErrorTypePermissionsError string = "PermissionsError"
	// BFErrorErrorTypePreconditionFailed captures enum value "PreconditionFailed"
	BFErrorErrorTypePreconditionFailed string = "PreconditionFailed"
	// BFErrorErrorTypeNotImplemented captures enum value "NotImplemented"
	BFErrorErrorTypeNotImplemented string = "NotImplemented"
	// BFErrorErrorTypeInvocationError captures enum value "InvocationError"
	BFErrorErrorTypeInvocationError string = "InvocationError"
	// BFErrorErrorTypeNoSuchEntity captures enum value "NoSuchEntity"
	BFErrorErrorTypeNoSuchEntity string = "NoSuchEntity"
	// BFErrorErrorTypeInconsistentState captures enum value "InconsistentState"
	BFErrorErrorTypeInconsistentState string = "InconsistentState"
	// BFErrorErrorTypeStripeOperationFailure captures enum value "StripeOperationFailure"
	BFErrorErrorTypeStripeOperationFailure string = "StripeOperationFailure"
	// BFErrorErrorTypeBraintreeOperationFailure captures enum value "BraintreeOperationFailure"
	BFErrorErrorTypeBraintreeOperationFailure string = "BraintreeOperationFailure"
	// BFErrorErrorTypeBraintreeValidationError captures enum value "BraintreeValidationError"
	BFErrorErrorTypeBraintreeValidationError string = "BraintreeValidationError"
	// BFErrorErrorTypeSagePayOperationFailure captures enum value "SagePayOperationFailure"
	BFErrorErrorTypeSagePayOperationFailure string = "SagePayOperationFailure"
	// BFErrorErrorTypeTokenizationAuthCaptureFailure captures enum value "TokenizationAuthCaptureFailure"
	BFErrorErrorTypeTokenizationAuthCaptureFailure string = "TokenizationAuthCaptureFailure"
	// BFErrorErrorTypeTokenizationPreAuthFailure captures enum value "TokenizationPreAuthFailure"
	BFErrorErrorTypeTokenizationPreAuthFailure string = "TokenizationPreAuthFailure"
	// BFErrorErrorTypeCouponException captures enum value "CouponException"
	BFErrorErrorTypeCouponException string = "CouponException"
	// BFErrorErrorTypeCouponUniqueCodesRequestException captures enum value "CouponUniqueCodesRequestException"
	BFErrorErrorTypeCouponUniqueCodesRequestException string = "CouponUniqueCodesRequestException"
	// BFErrorErrorTypeCouponUniqueCodesResponseException captures enum value "CouponUniqueCodesResponseException"
	BFErrorErrorTypeCouponUniqueCodesResponseException string = "CouponUniqueCodesResponseException"
	// BFErrorErrorTypeRemoveCouponException captures enum value "RemoveCouponException"
	BFErrorErrorTypeRemoveCouponException string = "RemoveCouponException"
	// BFErrorErrorTypeAddCouponCodeToSubscriptionRequestException captures enum value "AddCouponCodeToSubscriptionRequestException"
	BFErrorErrorTypeAddCouponCodeToSubscriptionRequestException string = "AddCouponCodeToSubscriptionRequestException"
	// BFErrorErrorTypeGatewayAuthenticationError captures enum value "GatewayAuthenticationError"
	BFErrorErrorTypeGatewayAuthenticationError string = "GatewayAuthenticationError"
	// BFErrorErrorTypeGatewayAuthorizationError captures enum value "GatewayAuthorizationError"
	BFErrorErrorTypeGatewayAuthorizationError string = "GatewayAuthorizationError"
	// BFErrorErrorTypeGatewayResourceNotFoundError captures enum value "GatewayResourceNotFoundError"
	BFErrorErrorTypeGatewayResourceNotFoundError string = "GatewayResourceNotFoundError"
	// BFErrorErrorTypeGatewayProtocolVersionError captures enum value "GatewayProtocolVersionError"
	BFErrorErrorTypeGatewayProtocolVersionError string = "GatewayProtocolVersionError"
	// BFErrorErrorTypeGatewayInternalError captures enum value "GatewayInternalError"
	BFErrorErrorTypeGatewayInternalError string = "GatewayInternalError"
	// BFErrorErrorTypeGatewayDownTemporarilyError captures enum value "GatewayDownTemporarilyError"
	BFErrorErrorTypeGatewayDownTemporarilyError string = "GatewayDownTemporarilyError"
	// BFErrorErrorTypeGatewayUnexpectedError captures enum value "GatewayUnexpectedError"
	BFErrorErrorTypeGatewayUnexpectedError string = "GatewayUnexpectedError"
	// BFErrorErrorTypeGatewayUnhandledError captures enum value "GatewayUnhandledError"
	BFErrorErrorTypeGatewayUnhandledError string = "GatewayUnhandledError"
	// BFErrorErrorTypeGatewaySDKUnhandledError captures enum value "GatewaySDKUnhandledError"
	BFErrorErrorTypeGatewaySDKUnhandledError string = "GatewaySDKUnhandledError"
)
View Source 
const (
	// CancelSubscriptionRequestCancellationCreditCredit captures enum value "Credit"
	CancelSubscriptionRequestCancellationCreditCredit string = "Credit"
	// CancelSubscriptionRequestCancellationCreditNone captures enum value "None"
	CancelSubscriptionRequestCancellationCreditNone string = "None"
)
View Source 
const (
	// CancelSubscriptionRequestServiceEndImmediate captures enum value "Immediate"
	CancelSubscriptionRequestServiceEndImmediate string = "Immediate"
	// CancelSubscriptionRequestServiceEndAtPeriodEnd captures enum value "AtPeriodEnd"
	CancelSubscriptionRequestServiceEndAtPeriodEnd string = "AtPeriodEnd"
)
View Source 
const (
	// CreateAggregatingSubscriptionRequestDurationPeriodMinutes captures enum value "minutes"
	CreateAggregatingSubscriptionRequestDurationPeriodMinutes string = "minutes"
	// CreateAggregatingSubscriptionRequestDurationPeriodDays captures enum value "days"
	CreateAggregatingSubscriptionRequestDurationPeriodDays string = "days"
	// CreateAggregatingSubscriptionRequestDurationPeriodMonths captures enum value "months"
	CreateAggregatingSubscriptionRequestDurationPeriodMonths string = "months"
	// CreateAggregatingSubscriptionRequestDurationPeriodYears captures enum value "years"
	CreateAggregatingSubscriptionRequestDurationPeriodYears string = "years"
)
View Source 
const (
	// CreateAggregatingSubscriptionRequestProductTypeNonrecurring captures enum value "nonrecurring"
	CreateAggregatingSubscriptionRequestProductTypeNonrecurring string = "nonrecurring"
	// CreateAggregatingSubscriptionRequestProductTypeRecurring captures enum value "recurring"
	CreateAggregatingSubscriptionRequestProductTypeRecurring string = "recurring"
)
View Source 
const (
	// CreateAggregatingSubscriptionRequestStateTrial captures enum value "Trial"
	CreateAggregatingSubscriptionRequestStateTrial string = "Trial"
	// CreateAggregatingSubscriptionRequestStateProvisioned captures enum value "Provisioned"
	CreateAggregatingSubscriptionRequestStateProvisioned string = "Provisioned"
	// CreateAggregatingSubscriptionRequestStatePaid captures enum value "Paid"
	CreateAggregatingSubscriptionRequestStatePaid string = "Paid"
	// CreateAggregatingSubscriptionRequestStateAwaitingPayment captures enum value "AwaitingPayment"
	CreateAggregatingSubscriptionRequestStateAwaitingPayment string = "AwaitingPayment"
	// CreateAggregatingSubscriptionRequestStateCancelled captures enum value "Cancelled"
	CreateAggregatingSubscriptionRequestStateCancelled string = "Cancelled"
	// CreateAggregatingSubscriptionRequestStateFailed captures enum value "Failed"
	CreateAggregatingSubscriptionRequestStateFailed string = "Failed"
	// CreateAggregatingSubscriptionRequestStateExpired captures enum value "Expired"
	CreateAggregatingSubscriptionRequestStateExpired string = "Expired"
)
View Source 
const (
	// CreateSubscriptionRequestFailedPaymentBehaviourCancelSubscription captures enum value "CancelSubscription"
	CreateSubscriptionRequestFailedPaymentBehaviourCancelSubscription string = "CancelSubscription"
	// CreateSubscriptionRequestFailedPaymentBehaviourNone captures enum value "None"
	CreateSubscriptionRequestFailedPaymentBehaviourNone string = "None"
)
View Source 
const (
	// CreateSubscriptionRequestStateTrial captures enum value "Trial"
	CreateSubscriptionRequestStateTrial string = "Trial"
	// CreateSubscriptionRequestStateProvisioned captures enum value "Provisioned"
	CreateSubscriptionRequestStateProvisioned string = "Provisioned"
	// CreateSubscriptionRequestStatePaid captures enum value "Paid"
	CreateSubscriptionRequestStatePaid string = "Paid"
	// CreateSubscriptionRequestStateAwaitingPayment captures enum value "AwaitingPayment"
	CreateSubscriptionRequestStateAwaitingPayment string = "AwaitingPayment"
	// CreateSubscriptionRequestStateCancelled captures enum value "Cancelled"
	CreateSubscriptionRequestStateCancelled string = "Cancelled"
	// CreateSubscriptionRequestStateFailed captures enum value "Failed"
	CreateSubscriptionRequestStateFailed string = "Failed"
	// CreateSubscriptionRequestStateExpired captures enum value "Expired"
	CreateSubscriptionRequestStateExpired string = "Expired"
)
View Source 
const (
	// CreateSubscriptionRequestTypeSubscription captures enum value "Subscription"
	CreateSubscriptionRequestTypeSubscription string = "Subscription"
	// CreateSubscriptionRequestTypeFixedTerm captures enum value "FixedTerm"
	CreateSubscriptionRequestTypeFixedTerm string = "FixedTerm"
	// CreateSubscriptionRequestTypeTrial captures enum value "Trial"
	CreateSubscriptionRequestTypeTrial string = "Trial"
)
View Source 
const (
	// CreditNoteTypeInvoice captures enum value "invoice"
	CreditNoteTypeInvoice string = "invoice"
	// CreditNoteTypeManual captures enum value "manual"
	CreditNoteTypeManual string = "manual"
)
View Source 
const (
	// DunningLineGatewayCybersourceToken captures enum value "cybersource_token"
	DunningLineGatewayCybersourceToken string = "cybersource_token"
	// DunningLineGatewayCardVault captures enum value "card_vault"
	DunningLineGatewayCardVault string = "card_vault"
	// DunningLineGatewayPaypalSimple captures enum value "paypal_simple"
	DunningLineGatewayPaypalSimple string = "paypal_simple"
	// DunningLineGatewayLocustworld captures enum value "locustworld"
	DunningLineGatewayLocustworld string = "locustworld"
	// DunningLineGatewayFree captures enum value "free"
	DunningLineGatewayFree string = "free"
	// DunningLineGatewayCoupon captures enum value "coupon"
	DunningLineGatewayCoupon string = "coupon"
	// DunningLineGatewayCreditNote captures enum value "credit_note"
	DunningLineGatewayCreditNote string = "credit_note"
	// DunningLineGatewayStripe captures enum value "stripe"
	DunningLineGatewayStripe string = "stripe"
	// DunningLineGatewayBraintree captures enum value "braintree"
	DunningLineGatewayBraintree string = "braintree"
	// DunningLineGatewayBalanced captures enum value "balanced"
	DunningLineGatewayBalanced string = "balanced"
	// DunningLineGatewayPaypal captures enum value "paypal"
	DunningLineGatewayPaypal string = "paypal"
	// DunningLineGatewayBillforwardTest captures enum value "billforward_test"
	DunningLineGatewayBillforwardTest string = "billforward_test"
	// DunningLineGatewayOffline captures enum value "offline"
	DunningLineGatewayOffline string = "offline"
	// DunningLineGatewayTrial captures enum value "trial"
	DunningLineGatewayTrial string = "trial"
	// DunningLineGatewayStripeACH captures enum value "stripeACH"
	DunningLineGatewayStripeACH string = "stripeACH"
	// DunningLineGatewayAuthorizeNet captures enum value "authorizeNet"
	DunningLineGatewayAuthorizeNet string = "authorizeNet"
	// DunningLineGatewaySpreedly captures enum value "spreedly"
	DunningLineGatewaySpreedly string = "spreedly"
	// DunningLineGatewaySagePay captures enum value "sagePay"
	DunningLineGatewaySagePay string = "sagePay"
	// DunningLineGatewayTrustCommerce captures enum value "trustCommerce"
	DunningLineGatewayTrustCommerce string = "trustCommerce"
	// DunningLineGatewayPayvision captures enum value "payvision"
	DunningLineGatewayPayvision string = "payvision"
	// DunningLineGatewayKash captures enum value "kash"
	DunningLineGatewayKash string = "kash"
)
View Source 
const (
	// DunningLineTypeInvoice captures enum value "Invoice"
	DunningLineTypeInvoice string = "Invoice"
	// DunningLineTypeNotification captures enum value "Notification"
	DunningLineTypeNotification string = "Notification"
)
View Source 
const (
	// FixedTermExpiryBehaviourExpireSubscription captures enum value "ExpireSubscription"
	FixedTermExpiryBehaviourExpireSubscription string = "ExpireSubscription"
	// FixedTermExpiryBehaviourEvergreenSubscription captures enum value "EvergreenSubscription"
	FixedTermExpiryBehaviourEvergreenSubscription string = "EvergreenSubscription"
	// FixedTermExpiryBehaviourRecurUplift captures enum value "RecurUplift"
	FixedTermExpiryBehaviourRecurUplift string = "RecurUplift"
	// FixedTermExpiryBehaviourRecurLatestPricing captures enum value "RecurLatestPricing"
	FixedTermExpiryBehaviourRecurLatestPricing string = "RecurLatestPricing"
)
View Source 
const (
	// FixedTermStateNeedsAmendments captures enum value "NeedsAmendments"
	FixedTermStateNeedsAmendments string = "NeedsAmendments"
	// FixedTermStateActive captures enum value "Active"
	FixedTermStateActive string = "Active"
	// FixedTermStateExpired captures enum value "Expired"
	FixedTermStateExpired string = "Expired"
)
View Source 
const (
	// InsertableBillingEntityModeImmediate captures enum value "immediate"
	InsertableBillingEntityModeImmediate string = "immediate"
	// InsertableBillingEntityModeDelayed captures enum value "delayed"
	InsertableBillingEntityModeDelayed string = "delayed"
)
View Source 
const (
	// InsertableBillingEntityStateNew captures enum value "New"
	InsertableBillingEntityStateNew string = "New"
	// InsertableBillingEntityStateAccepted captures enum value "Accepted"
	InsertableBillingEntityStateAccepted string = "Accepted"
	// InsertableBillingEntityStateRejected captures enum value "Rejected"
	InsertableBillingEntityStateRejected string = "Rejected"
	// InsertableBillingEntityStateChargeCreated captures enum value "ChargeCreated"
	InsertableBillingEntityStateChargeCreated string = "ChargeCreated"
)
View Source 
const (
	// InvoiceManagedByBillForward captures enum value "BillForward"
	InvoiceManagedByBillForward string = "BillForward"
	// InvoiceManagedByStripe captures enum value "Stripe"
	InvoiceManagedByStripe string = "Stripe"
)
View Source 
const (
	// InvoiceStatePaid captures enum value "Paid"
	InvoiceStatePaid string = "Paid"
	// InvoiceStateUnpaid captures enum value "Unpaid"
	InvoiceStateUnpaid string = "Unpaid"
	// InvoiceStatePending captures enum value "Pending"
	InvoiceStatePending string = "Pending"
	// InvoiceStateVoided captures enum value "Voided"
	InvoiceStateVoided string = "Voided"
)
View Source 
const (
	// InvoiceTypeSubscription captures enum value "Subscription"
	InvoiceTypeSubscription string = "Subscription"
	// InvoiceTypeTrial captures enum value "Trial"
	InvoiceTypeTrial string = "Trial"
	// InvoiceTypeCharge captures enum value "Charge"
	InvoiceTypeCharge string = "Charge"
	// InvoiceTypeFinalArrears captures enum value "FinalArrears"
	InvoiceTypeFinalArrears string = "FinalArrears"
	// InvoiceTypeAmendment captures enum value "Amendment"
	InvoiceTypeAmendment string = "Amendment"
	// InvoiceTypeAggregated captures enum value "Aggregated"
	InvoiceTypeAggregated string = "Aggregated"
)
View Source 
const (
	// InvoiceLineChargeTypeCredit captures enum value "Credit"
	InvoiceLineChargeTypeCredit string = "Credit"
	// InvoiceLineChargeTypeDebit captures enum value "Debit"
	InvoiceLineChargeTypeDebit string = "Debit"
)
View Source 
const (
	// InvoiceLinePricingComponentTypeSetup captures enum value "setup"
	InvoiceLinePricingComponentTypeSetup string = "setup"
	// InvoiceLinePricingComponentTypeSubscription captures enum value "subscription"
	InvoiceLinePricingComponentTypeSubscription string = "subscription"
	// InvoiceLinePricingComponentTypeArrears captures enum value "arrears"
	InvoiceLinePricingComponentTypeArrears string = "arrears"
	// InvoiceLinePricingComponentTypeUsage captures enum value "usage"
	InvoiceLinePricingComponentTypeUsage string = "usage"
)
View Source 
const (
	// InvoiceLineTypePricingComponent captures enum value "PricingComponent"
	InvoiceLineTypePricingComponent string = "PricingComponent"
	// InvoiceLineTypeCoupon captures enum value "Coupon"
	InvoiceLineTypeCoupon string = "Coupon"
	// InvoiceLineTypeMigration captures enum value "Migration"
	InvoiceLineTypeMigration string = "Migration"
	// InvoiceLineTypeAggregatedInvoice captures enum value "AggregatedInvoice"
	InvoiceLineTypeAggregatedInvoice string = "AggregatedInvoice"
)
View Source 
const (
	// InvoicePaymentGatewayCybersourceToken captures enum value "cybersource_token"
	InvoicePaymentGatewayCybersourceToken string = "cybersource_token"
	// InvoicePaymentGatewayCardVault captures enum value "card_vault"
	InvoicePaymentGatewayCardVault string = "card_vault"
	// InvoicePaymentGatewayPaypalSimple captures enum value "paypal_simple"
	InvoicePaymentGatewayPaypalSimple string = "paypal_simple"
	// InvoicePaymentGatewayLocustworld captures enum value "locustworld"
	InvoicePaymentGatewayLocustworld string = "locustworld"
	// InvoicePaymentGatewayFree captures enum value "free"
	InvoicePaymentGatewayFree string = "free"
	// InvoicePaymentGatewayCoupon captures enum value "coupon"
	InvoicePaymentGatewayCoupon string = "coupon"
	// InvoicePaymentGatewayCreditNote captures enum value "credit_note"
	InvoicePaymentGatewayCreditNote string = "credit_note"
	// InvoicePaymentGatewayStripe captures enum value "stripe"
	InvoicePaymentGatewayStripe string = "stripe"
	// InvoicePaymentGatewayBraintree captures enum value "braintree"
	InvoicePaymentGatewayBraintree string = "braintree"
	// InvoicePaymentGatewayBalanced captures enum value "balanced"
	InvoicePaymentGatewayBalanced string = "balanced"
	// InvoicePaymentGatewayPaypal captures enum value "paypal"
	InvoicePaymentGatewayPaypal string = "paypal"
	// InvoicePaymentGatewayBillforwardTest captures enum value "billforward_test"
	InvoicePaymentGatewayBillforwardTest string = "billforward_test"
	// InvoicePaymentGatewayOffline captures enum value "offline"
	InvoicePaymentGatewayOffline string = "offline"
	// InvoicePaymentGatewayTrial captures enum value "trial"
	InvoicePaymentGatewayTrial string = "trial"
	// InvoicePaymentGatewayStripeACH captures enum value "stripeACH"
	InvoicePaymentGatewayStripeACH string = "stripeACH"
	// InvoicePaymentGatewayAuthorizeNet captures enum value "authorizeNet"
	InvoicePaymentGatewayAuthorizeNet string = "authorizeNet"
	// InvoicePaymentGatewaySpreedly captures enum value "spreedly"
	InvoicePaymentGatewaySpreedly string = "spreedly"
	// InvoicePaymentGatewaySagePay captures enum value "sagePay"
	InvoicePaymentGatewaySagePay string = "sagePay"
	// InvoicePaymentGatewayTrustCommerce captures enum value "trustCommerce"
	InvoicePaymentGatewayTrustCommerce string = "trustCommerce"
	// InvoicePaymentGatewayPayvision captures enum value "payvision"
	InvoicePaymentGatewayPayvision string = "payvision"
	// InvoicePaymentGatewayKash captures enum value "kash"
	InvoicePaymentGatewayKash string = "kash"
)
View Source 
const (
	// MutableBillingEntityScopeManual captures enum value "Manual"
	MutableBillingEntityScopeManual string = "Manual"
	// MutableBillingEntityScopeScheduled captures enum value "Scheduled"
	MutableBillingEntityScopeScheduled string = "Scheduled"
)
View Source 
const (
	// MutableBillingEntityStatePending captures enum value "Pending"
	MutableBillingEntityStatePending string = "Pending"
	// MutableBillingEntityStateComplete captures enum value "Complete"
	MutableBillingEntityStateComplete string = "Complete"
	// MutableBillingEntityStateFailed captures enum value "Failed"
	MutableBillingEntityStateFailed string = "Failed"
	// MutableBillingEntityStateCancelled captures enum value "Cancelled"
	MutableBillingEntityStateCancelled string = "Cancelled"
	// MutableBillingEntityStateProcessing captures enum value "Processing"
	MutableBillingEntityStateProcessing string = "Processing"
)
View Source 
const (
	// MutableBillingEntityTypeIncremental captures enum value "Incremental"
	MutableBillingEntityTypeIncremental string = "Incremental"
	// MutableBillingEntityTypeFull captures enum value "Full"
	MutableBillingEntityTypeFull string = "Full"
)
View Source 
const (
	// NotificationActionAccept captures enum value "Accept"
	NotificationActionAccept string = "Accept"
	// NotificationActionActive captures enum value "Active"
	NotificationActionActive string = "Active"
	// NotificationActionAwaitingPayment captures enum value "AwaitingPayment"
	NotificationActionAwaitingPayment string = "AwaitingPayment"
	// NotificationActionAwaitingRefund captures enum value "AwaitingRefund"
	NotificationActionAwaitingRefund string = "AwaitingRefund"
	// NotificationActionCancelled captures enum value "Cancelled"
	NotificationActionCancelled string = "Cancelled"
	// NotificationActionCompleted captures enum value "Completed"
	NotificationActionCompleted string = "Completed"
	// NotificationActionCreated captures enum value "Created"
	NotificationActionCreated string = "Created"
	// NotificationActionError captures enum value "Error"
	NotificationActionError string = "Error"
	// NotificationActionExpiring captures enum value "Expiring"
	NotificationActionExpiring string = "Expiring"
	// NotificationActionExpired captures enum value "Expired"
	NotificationActionExpired string = "Expired"
	// NotificationActionFailed captures enum value "Failed"
	NotificationActionFailed string = "Failed"
	// NotificationActionMigrated captures enum value "Migrated"
	NotificationActionMigrated string = "Migrated"
	// NotificationActionNeedsAmendments captures enum value "NeedsAmendments"
	NotificationActionNeedsAmendments string = "NeedsAmendments"
	// NotificationActionPaid captures enum value "Paid"
	NotificationActionPaid string = "Paid"
	// NotificationActionPending captures enum value "Pending"
	NotificationActionPending string = "Pending"
	// NotificationActionProvisioned captures enum value "Provisioned"
	NotificationActionProvisioned string = "Provisioned"
	// NotificationActionRefunded captures enum value "Refunded"
	NotificationActionRefunded string = "Refunded"
	// NotificationActionReject captures enum value "Reject"
	NotificationActionReject string = "Reject"
	// NotificationActionTrial captures enum value "Trial"
	NotificationActionTrial string = "Trial"
	// NotificationActionUnknown captures enum value "Unknown"
	NotificationActionUnknown string = "Unknown"
	// NotificationActionUnpaid captures enum value "Unpaid"
	NotificationActionUnpaid string = "Unpaid"
	// NotificationActionUpdated captures enum value "Updated"
	NotificationActionUpdated string = "Updated"
	// NotificationActionVoided captures enum value "Voided"
	NotificationActionVoided string = "Voided"
	// NotificationActionPaymentFailed captures enum value "PaymentFailed"
	NotificationActionPaymentFailed string = "PaymentFailed"
)
View Source 
const (
	// NotificationDomainNotification captures enum value "Notification"
	NotificationDomainNotification string = "Notification"
	// NotificationDomainOrganization captures enum value "Organization"
	NotificationDomainOrganization string = "Organization"
	// NotificationDomainOrganizationGateway captures enum value "OrganizationGateway"
	NotificationDomainOrganizationGateway string = "OrganizationGateway"
	// NotificationDomainProduct captures enum value "Product"
	NotificationDomainProduct string = "Product"
	// NotificationDomainUser captures enum value "User"
	NotificationDomainUser string = "User"
	// NotificationDomainSubscription captures enum value "Subscription"
	NotificationDomainSubscription string = "Subscription"
	// NotificationDomainProfile captures enum value "Profile"
	NotificationDomainProfile string = "Profile"
	// NotificationDomainProductRatePlan captures enum value "ProductRatePlan"
	NotificationDomainProductRatePlan string = "ProductRatePlan"
	// NotificationDomainClient captures enum value "Client"
	NotificationDomainClient string = "Client"
	// NotificationDomainInvoice captures enum value "Invoice"
	NotificationDomainInvoice string = "Invoice"
	// NotificationDomainPricingComponentValue captures enum value "PricingComponentValue"
	NotificationDomainPricingComponentValue string = "PricingComponentValue"
	// NotificationDomainAccount captures enum value "Account"
	NotificationDomainAccount string = "Account"
	// NotificationDomainPricingComponentValueChange captures enum value "PricingComponentValueChange"
	NotificationDomainPricingComponentValueChange string = "PricingComponentValueChange"
	// NotificationDomainPricingComponentTier captures enum value "PricingComponentTier"
	NotificationDomainPricingComponentTier string = "PricingComponentTier"
	// NotificationDomainPricingComponent captures enum value "PricingComponent"
	NotificationDomainPricingComponent string = "PricingComponent"
	// NotificationDomainPricingCalculation captures enum value "PricingCalculation"
	NotificationDomainPricingCalculation string = "PricingCalculation"
	// NotificationDomainCoupon captures enum value "Coupon"
	NotificationDomainCoupon string = "Coupon"
	// NotificationDomainCouponDiscount captures enum value "CouponDiscount"
	NotificationDomainCouponDiscount string = "CouponDiscount"
	// NotificationDomainCouponDefinition captures enum value "CouponDefinition"
	NotificationDomainCouponDefinition string = "CouponDefinition"
	// NotificationDomainCouponInstance captures enum value "CouponInstance"
	NotificationDomainCouponInstance string = "CouponInstance"
	// NotificationDomainCouponModifier captures enum value "CouponModifier"
	NotificationDomainCouponModifier string = "CouponModifier"
	// NotificationDomainCouponRule captures enum value "CouponRule"
	NotificationDomainCouponRule string = "CouponRule"
	// NotificationDomainCouponBookDefinition captures enum value "CouponBookDefinition"
	NotificationDomainCouponBookDefinition string = "CouponBookDefinition"
	// NotificationDomainCouponBook captures enum value "CouponBook"
	NotificationDomainCouponBook string = "CouponBook"
	// NotificationDomainInvoiceLine captures enum value "InvoiceLine"
	NotificationDomainInvoiceLine string = "InvoiceLine"
	// NotificationDomainWebhook captures enum value "Webhook"
	NotificationDomainWebhook string = "Webhook"
	// NotificationDomainWebhookSubscription captures enum value "WebhookSubscription"
	NotificationDomainWebhookSubscription string = "WebhookSubscription"
	// NotificationDomainSubscriptionCancellation captures enum value "SubscriptionCancellation"
	NotificationDomainSubscriptionCancellation string = "SubscriptionCancellation"
	// NotificationDomainNotificationSnapshot captures enum value "NotificationSnapshot"
	NotificationDomainNotificationSnapshot string = "NotificationSnapshot"
	// NotificationDomainInvoicePayment captures enum value "InvoicePayment"
	NotificationDomainInvoicePayment string = "InvoicePayment"
	// NotificationDomainPayment captures enum value "Payment"
	NotificationDomainPayment string = "Payment"
	// NotificationDomainPaymentMethod captures enum value "PaymentMethod"
	NotificationDomainPaymentMethod string = "PaymentMethod"
	// NotificationDomainPaymentMethodSubscriptionLink captures enum value "PaymentMethodSubscriptionLink"
	NotificationDomainPaymentMethodSubscriptionLink string = "PaymentMethodSubscriptionLink"
	// NotificationDomainDunningLine captures enum value "DunningLine"
	NotificationDomainDunningLine string = "DunningLine"
	// NotificationDomainCybersourceToken captures enum value "CybersourceToken"
	NotificationDomainCybersourceToken string = "CybersourceToken"
	// NotificationDomainCard captures enum value "Card"
	NotificationDomainCard string = "Card"
	// NotificationDomainAlias captures enum value "Alias"
	NotificationDomainAlias string = "Alias"
	// NotificationDomainPaypalSimplePaymentReconciliation captures enum value "PaypalSimplePaymentReconciliation"
	NotificationDomainPaypalSimplePaymentReconciliation string = "PaypalSimplePaymentReconciliation"
	// NotificationDomainFreePaymentReconciliation captures enum value "FreePaymentReconciliation"
	NotificationDomainFreePaymentReconciliation string = "FreePaymentReconciliation"
	// NotificationDomainLocustworldPaymentReconciliation captures enum value "LocustworldPaymentReconciliation"
	NotificationDomainLocustworldPaymentReconciliation string = "LocustworldPaymentReconciliation"
	// NotificationDomainCouponInstanceExistingValue captures enum value "CouponInstanceExistingValue"
	NotificationDomainCouponInstanceExistingValue string = "CouponInstanceExistingValue"
	// NotificationDomainTaxLine captures enum value "TaxLine"
	NotificationDomainTaxLine string = "TaxLine"
	// NotificationDomainTaxationStrategy captures enum value "TaxationStrategy"
	NotificationDomainTaxationStrategy string = "TaxationStrategy"
	// NotificationDomainTaxationLink captures enum value "TaxationLink"
	NotificationDomainTaxationLink string = "TaxationLink"
	// NotificationDomainAddress captures enum value "Address"
	NotificationDomainAddress string = "Address"
	// NotificationDomainAmendmentPriceNTime captures enum value "AmendmentPriceNTime"
	NotificationDomainAmendmentPriceNTime string = "AmendmentPriceNTime"
	// NotificationDomainAuthority captures enum value "Authority"
	NotificationDomainAuthority string = "Authority"
	// NotificationDomainUnitOfMeasure captures enum value "UnitOfMeasure"
	NotificationDomainUnitOfMeasure string = "UnitOfMeasure"
	// NotificationDomainSearchResult captures enum value "SearchResult"
	NotificationDomainSearchResult string = "SearchResult"
	// NotificationDomainAmendment captures enum value "Amendment"
	NotificationDomainAmendment string = "Amendment"
	// NotificationDomainAuditLog captures enum value "AuditLog"
	NotificationDomainAuditLog string = "AuditLog"
	// NotificationDomainPassword captures enum value "Password"
	NotificationDomainPassword string = "Password"
	// NotificationDomainUsername captures enum value "Username"
	NotificationDomainUsername string = "Username"
	// NotificationDomainFixedTermDefinition captures enum value "FixedTermDefinition"
	NotificationDomainFixedTermDefinition string = "FixedTermDefinition"
	// NotificationDomainFixedTerm captures enum value "FixedTerm"
	NotificationDomainFixedTerm string = "FixedTerm"
	// NotificationDomainRefund captures enum value "Refund"
	NotificationDomainRefund string = "Refund"
	// NotificationDomainCreditNote captures enum value "CreditNote"
	NotificationDomainCreditNote string = "CreditNote"
	// NotificationDomainReceipt captures enum value "Receipt"
	NotificationDomainReceipt string = "Receipt"
	// NotificationDomainAmendmentCompoundConstituent captures enum value "AmendmentCompoundConstituent"
	NotificationDomainAmendmentCompoundConstituent string = "AmendmentCompoundConstituent"
	// NotificationDomainAPIConfiguration captures enum value "APIConfiguration"
	NotificationDomainAPIConfiguration string = "APIConfiguration"
	// NotificationDomainStripeToken captures enum value "StripeToken"
	NotificationDomainStripeToken string = "StripeToken"
	// NotificationDomainBraintreeToken captures enum value "BraintreeToken"
	NotificationDomainBraintreeToken string = "BraintreeToken"
	// NotificationDomainBalancedToken captures enum value "BalancedToken"
	NotificationDomainBalancedToken string = "BalancedToken"
	// NotificationDomainAuthorizeNetToken captures enum value "AuthorizeNetToken"
	NotificationDomainAuthorizeNetToken string = "AuthorizeNetToken"
	// NotificationDomainPaypalToken captures enum value "PaypalToken"
	NotificationDomainPaypalToken string = "PaypalToken"
	// NotificationDomainSpreedlyToken captures enum value "SpreedlyToken"
	NotificationDomainSpreedlyToken string = "SpreedlyToken"
	// NotificationDomainSagePayToken captures enum value "SagePayToken"
	NotificationDomainSagePayToken string = "SagePayToken"
	// NotificationDomainTrustCommerceToken captures enum value "TrustCommerceToken"
	NotificationDomainTrustCommerceToken string = "TrustCommerceToken"
	// NotificationDomainPayVisionToken captures enum value "PayVisionToken"
	NotificationDomainPayVisionToken string = "PayVisionToken"
	// NotificationDomainSagePayOutstandingTransaction captures enum value "SagePayOutstandingTransaction"
	NotificationDomainSagePayOutstandingTransaction string = "SagePayOutstandingTransaction"
	// NotificationDomainSagePayEnabledCardType captures enum value "SagePayEnabledCardType"
	NotificationDomainSagePayEnabledCardType string = "SagePayEnabledCardType"
	// NotificationDomainSagePayTransaction captures enum value "SagePayTransaction"
	NotificationDomainSagePayTransaction string = "SagePayTransaction"
	// NotificationDomainGatewayRevenue captures enum value "GatewayRevenue"
	NotificationDomainGatewayRevenue string = "GatewayRevenue"
	// NotificationDomainMigration captures enum value "Migration"
	NotificationDomainMigration string = "Migration"
	// NotificationDomainAdhocSubscription captures enum value "AdhocSubscription"
	NotificationDomainAdhocSubscription string = "AdhocSubscription"
	// NotificationDomainSubscriptionCharge captures enum value "SubscriptionCharge"
	NotificationDomainSubscriptionCharge string = "SubscriptionCharge"
	// NotificationDomainComponentChange captures enum value "ComponentChange"
	NotificationDomainComponentChange string = "ComponentChange"
	// NotificationDomainVerification captures enum value "Verification"
	NotificationDomainVerification string = "Verification"
	// NotificationDomainUsageRoundingStrategies captures enum value "UsageRoundingStrategies"
	NotificationDomainUsageRoundingStrategies string = "UsageRoundingStrategies"
	// NotificationDomainPricingComponentValueMigrationChargeAmendmentMapping captures enum value "PricingComponentValueMigrationChargeAmendmentMapping"
	NotificationDomainPricingComponentValueMigrationChargeAmendmentMapping string = "PricingComponentValueMigrationChargeAmendmentMapping"
	// NotificationDomainAmendmentDiscardAmendment captures enum value "AmendmentDiscardAmendment"
	NotificationDomainAmendmentDiscardAmendment string = "AmendmentDiscardAmendment"
	// NotificationDomainEntityTime captures enum value "EntityTime"
	NotificationDomainEntityTime string = "EntityTime"
	// NotificationDomainAggregatingComponent captures enum value "AggregatingComponent"
	NotificationDomainAggregatingComponent string = "AggregatingComponent"
	// NotificationDomainPricingComponentMigrationValue captures enum value "PricingComponentMigrationValue"
	NotificationDomainPricingComponentMigrationValue string = "PricingComponentMigrationValue"
	// NotificationDomainMetadataKeyValue captures enum value "MetadataKeyValue"
	NotificationDomainMetadataKeyValue string = "MetadataKeyValue"
	// NotificationDomainMetadata captures enum value "Metadata"
	NotificationDomainMetadata string = "Metadata"
	// NotificationDomainAggregationLink captures enum value "AggregationLink"
	NotificationDomainAggregationLink string = "AggregationLink"
	// NotificationDomainBFPermission captures enum value "BFPermission"
	NotificationDomainBFPermission string = "BFPermission"
	// NotificationDomainRole captures enum value "Role"
	NotificationDomainRole string = "Role"
	// NotificationDomainPermissionLink captures enum value "PermissionLink"
	NotificationDomainPermissionLink string = "PermissionLink"
	// NotificationDomainPayVisionTransaction captures enum value "PayVisionTransaction"
	NotificationDomainPayVisionTransaction string = "PayVisionTransaction"
	// NotificationDomainKashToken captures enum value "KashToken"
	NotificationDomainKashToken string = "KashToken"
	// NotificationDomainDataSynchronizationJob captures enum value "DataSynchronizationJob"
	NotificationDomainDataSynchronizationJob string = "DataSynchronizationJob"
	// NotificationDomainDataSynchronizationJobError captures enum value "DataSynchronizationJobError"
	NotificationDomainDataSynchronizationJobError string = "DataSynchronizationJobError"
	// NotificationDomainDataSynchronizationConfiguration captures enum value "DataSynchronizationConfiguration"
	NotificationDomainDataSynchronizationConfiguration string = "DataSynchronizationConfiguration"
	// NotificationDomainDataSynchronizationAppConfiguration captures enum value "DataSynchronizationAppConfiguration"
	NotificationDomainDataSynchronizationAppConfiguration string = "DataSynchronizationAppConfiguration"
	// NotificationDomainAggregationChildrenResponse captures enum value "AggregationChildrenResponse"
	NotificationDomainAggregationChildrenResponse string = "AggregationChildrenResponse"
	// NotificationDomainInvoiceLinePayment captures enum value "InvoiceLinePayment"
	NotificationDomainInvoiceLinePayment string = "InvoiceLinePayment"
	// NotificationDomainEmailSubscription captures enum value "EmailSubscription"
	NotificationDomainEmailSubscription string = "EmailSubscription"
	// NotificationDomainEmailProvider captures enum value "EmailProvider"
	NotificationDomainEmailProvider string = "EmailProvider"
	// NotificationDomainTimeResponse captures enum value "TimeResponse"
	NotificationDomainTimeResponse string = "TimeResponse"
	// NotificationDomainEmail captures enum value "Email"
	NotificationDomainEmail string = "Email"
	// NotificationDomainRevenueAttribution captures enum value "RevenueAttribution"
	NotificationDomainRevenueAttribution string = "RevenueAttribution"
	// NotificationDomainUnknown captures enum value "Unknown"
	NotificationDomainUnknown string = "Unknown"
)
View Source 
const (
	// NotificationFormatJSON captures enum value "JSON"
	NotificationFormatJSON string = "JSON"
	// NotificationFormatXML captures enum value "XML"
	NotificationFormatXML string = "XML"
)
View Source 
const (
	// NotificationStateUnsent captures enum value "Unsent"
	NotificationStateUnsent string = "Unsent"
	// NotificationStateSending captures enum value "Sending"
	NotificationStateSending string = "Sending"
	// NotificationStateSent captures enum value "Sent"
	NotificationStateSent string = "Sent"
)
View Source 
const (
	// PaymentGatewayCybersourceToken captures enum value "cybersource_token"
	PaymentGatewayCybersourceToken string = "cybersource_token"
	// PaymentGatewayCardVault captures enum value "card_vault"
	PaymentGatewayCardVault string = "card_vault"
	// PaymentGatewayPaypalSimple captures enum value "paypal_simple"
	PaymentGatewayPaypalSimple string = "paypal_simple"
	// PaymentGatewayLocustworld captures enum value "locustworld"
	PaymentGatewayLocustworld string = "locustworld"
	// PaymentGatewayFree captures enum value "free"
	PaymentGatewayFree string = "free"
	// PaymentGatewayCoupon captures enum value "coupon"
	PaymentGatewayCoupon string = "coupon"
	// PaymentGatewayCreditNote captures enum value "credit_note"
	PaymentGatewayCreditNote string = "credit_note"
	// PaymentGatewayStripe captures enum value "stripe"
	PaymentGatewayStripe string = "stripe"
	// PaymentGatewayBraintree captures enum value "braintree"
	PaymentGatewayBraintree string = "braintree"
	// PaymentGatewayBalanced captures enum value "balanced"
	PaymentGatewayBalanced string = "balanced"
	// PaymentGatewayPaypal captures enum value "paypal"
	PaymentGatewayPaypal string = "paypal"
	// PaymentGatewayBillforwardTest captures enum value "billforward_test"
	PaymentGatewayBillforwardTest string = "billforward_test"
	// PaymentGatewayOffline captures enum value "offline"
	PaymentGatewayOffline string = "offline"
	// PaymentGatewayTrial captures enum value "trial"
	PaymentGatewayTrial string = "trial"
	// PaymentGatewayStripeACH captures enum value "stripeACH"
	PaymentGatewayStripeACH string = "stripeACH"
	// PaymentGatewayAuthorizeNet captures enum value "authorizeNet"
	PaymentGatewayAuthorizeNet string = "authorizeNet"
	// PaymentGatewaySpreedly captures enum value "spreedly"
	PaymentGatewaySpreedly string = "spreedly"
	// PaymentGatewaySagePay captures enum value "sagePay"
	PaymentGatewaySagePay string = "sagePay"
	// PaymentGatewayTrustCommerce captures enum value "trustCommerce"
	PaymentGatewayTrustCommerce string = "trustCommerce"
	// PaymentGatewayPayvision captures enum value "payvision"
	PaymentGatewayPayvision string = "payvision"
	// PaymentGatewayKash captures enum value "kash"
	PaymentGatewayKash string = "kash"
)
View Source 
const (
	// PaymentTypeCredit captures enum value "credit"
	PaymentTypeCredit string = "credit"
	// PaymentTypeDebit captures enum value "debit"
	PaymentTypeDebit string = "debit"
)
View Source 
const (
	// PaymentMethodGatewayCybersourceToken captures enum value "cybersource_token"
	PaymentMethodGatewayCybersourceToken string = "cybersource_token"
	// PaymentMethodGatewayCardVault captures enum value "card_vault"
	PaymentMethodGatewayCardVault string = "card_vault"
	// PaymentMethodGatewayPaypalSimple captures enum value "paypal_simple"
	PaymentMethodGatewayPaypalSimple string = "paypal_simple"
	// PaymentMethodGatewayLocustworld captures enum value "locustworld"
	PaymentMethodGatewayLocustworld string = "locustworld"
	// PaymentMethodGatewayFree captures enum value "free"
	PaymentMethodGatewayFree string = "free"
	// PaymentMethodGatewayCoupon captures enum value "coupon"
	PaymentMethodGatewayCoupon string = "coupon"
	// PaymentMethodGatewayCreditNote captures enum value "credit_note"
	PaymentMethodGatewayCreditNote string = "credit_note"
	// PaymentMethodGatewayStripe captures enum value "stripe"
	PaymentMethodGatewayStripe string = "stripe"
	// PaymentMethodGatewayBraintree captures enum value "braintree"
	PaymentMethodGatewayBraintree string = "braintree"
	// PaymentMethodGatewayBalanced captures enum value "balanced"
	PaymentMethodGatewayBalanced string = "balanced"
	// PaymentMethodGatewayPaypal captures enum value "paypal"
	PaymentMethodGatewayPaypal string = "paypal"
	// PaymentMethodGatewayBillforwardTest captures enum value "billforward_test"
	PaymentMethodGatewayBillforwardTest string = "billforward_test"
	// PaymentMethodGatewayOffline captures enum value "offline"
	PaymentMethodGatewayOffline string = "offline"
	// PaymentMethodGatewayTrial captures enum value "trial"
	PaymentMethodGatewayTrial string = "trial"
	// PaymentMethodGatewayStripeACH captures enum value "stripeACH"
	PaymentMethodGatewayStripeACH string = "stripeACH"
	// PaymentMethodGatewayAuthorizeNet captures enum value "authorizeNet"
	PaymentMethodGatewayAuthorizeNet string = "authorizeNet"
	// PaymentMethodGatewaySpreedly captures enum value "spreedly"
	PaymentMethodGatewaySpreedly string = "spreedly"
	// PaymentMethodGatewaySagePay captures enum value "sagePay"
	PaymentMethodGatewaySagePay string = "sagePay"
	// PaymentMethodGatewayTrustCommerce captures enum value "trustCommerce"
	PaymentMethodGatewayTrustCommerce string = "trustCommerce"
	// PaymentMethodGatewayPayvision captures enum value "payvision"
	PaymentMethodGatewayPayvision string = "payvision"
	// PaymentMethodGatewayKash captures enum value "kash"
	PaymentMethodGatewayKash string = "kash"
)
View Source 
const (
	// PaymentMethodStatePending captures enum value "Pending"
	PaymentMethodStatePending string = "Pending"
	// PaymentMethodStateActive captures enum value "Active"
	PaymentMethodStateActive string = "Active"
	// PaymentMethodStateExpiring captures enum value "Expiring"
	PaymentMethodStateExpiring string = "Expiring"
	// PaymentMethodStateExpired captures enum value "Expired"
	PaymentMethodStateExpired string = "Expired"
)
View Source 
const (
	// PricingComponentTierPricingTypeUnit captures enum value "unit"
	PricingComponentTierPricingTypeUnit string = "unit"
	// PricingComponentTierPricingTypeFixed captures enum value "fixed"
	PricingComponentTierPricingTypeFixed string = "fixed"
)
View Source 
const (
	// ProductDurationPeriodMinutes captures enum value "minutes"
	ProductDurationPeriodMinutes string = "minutes"
	// ProductDurationPeriodDays captures enum value "days"
	ProductDurationPeriodDays string = "days"
	// ProductDurationPeriodMonths captures enum value "months"
	ProductDurationPeriodMonths string = "months"
	// ProductDurationPeriodYears captures enum value "years"
	ProductDurationPeriodYears string = "years"
)
View Source 
const (
	// ProductProductTypeNonrecurring captures enum value "nonrecurring"
	ProductProductTypeNonrecurring string = "nonrecurring"
	// ProductProductTypeRecurring captures enum value "recurring"
	ProductProductTypeRecurring string = "recurring"
)
View Source 
const (
	// ProductTrialPeriodNone captures enum value "none"
	ProductTrialPeriodNone string = "none"
	// ProductTrialPeriodMinutes captures enum value "minutes"
	ProductTrialPeriodMinutes string = "minutes"
	// ProductTrialPeriodDays captures enum value "days"
	ProductTrialPeriodDays string = "days"
	// ProductTrialPeriodMonths captures enum value "months"
	ProductTrialPeriodMonths string = "months"
)
View Source 
const (
	// ProductRatePlanDurationPeriodMinutes captures enum value "minutes"
	ProductRatePlanDurationPeriodMinutes string = "minutes"
	// ProductRatePlanDurationPeriodDays captures enum value "days"
	ProductRatePlanDurationPeriodDays string = "days"
	// ProductRatePlanDurationPeriodMonths captures enum value "months"
	ProductRatePlanDurationPeriodMonths string = "months"
	// ProductRatePlanDurationPeriodYears captures enum value "years"
	ProductRatePlanDurationPeriodYears string = "years"
)
View Source 
const (
	// ProductRatePlanFailedPaymentBehaviourCancelSubscription captures enum value "CancelSubscription"
	ProductRatePlanFailedPaymentBehaviourCancelSubscription string = "CancelSubscription"
	// ProductRatePlanFailedPaymentBehaviourNone captures enum value "None"
	ProductRatePlanFailedPaymentBehaviourNone string = "None"
)
View Source 
const (
	// ProductRatePlanInvoiceIssueTypeImmediate captures enum value "Immediate"
	ProductRatePlanInvoiceIssueTypeImmediate string = "Immediate"
	// ProductRatePlanInvoiceIssueTypeDelayed captures enum value "Delayed"
	ProductRatePlanInvoiceIssueTypeDelayed string = "Delayed"
	// ProductRatePlanInvoiceIssueTypeManual captures enum value "Manual"
	ProductRatePlanInvoiceIssueTypeManual string = "Manual"
)
View Source 
const (
	// ProductRatePlanIssuePeriodMinutes captures enum value "minutes"
	ProductRatePlanIssuePeriodMinutes string = "minutes"
	// ProductRatePlanIssuePeriodDays captures enum value "days"
	ProductRatePlanIssuePeriodDays string = "days"
	// ProductRatePlanIssuePeriodMonths captures enum value "months"
	ProductRatePlanIssuePeriodMonths string = "months"
	// ProductRatePlanIssuePeriodYears captures enum value "years"
	ProductRatePlanIssuePeriodYears string = "years"
)
View Source 
const (
	// ProductRatePlanMigrationBehaviourNoCharge captures enum value "NoCharge"
	ProductRatePlanMigrationBehaviourNoCharge string = "NoCharge"
	// ProductRatePlanMigrationBehaviourCreditAccount captures enum value "CreditAccount"
	ProductRatePlanMigrationBehaviourCreditAccount string = "CreditAccount"
)
View Source 
const (
	// ProductRatePlanProRataModeNone captures enum value "None"
	ProductRatePlanProRataModeNone string = "None"
	// ProductRatePlanProRataModeWithCoupon captures enum value "WithCoupon"
	ProductRatePlanProRataModeWithCoupon string = "WithCoupon"
	// ProductRatePlanProRataModeWithoutCoupon captures enum value "WithoutCoupon"
	ProductRatePlanProRataModeWithoutCoupon string = "WithoutCoupon"
	// ProductRatePlanProRataModeFull captures enum value "Full"
	ProductRatePlanProRataModeFull string = "Full"
)
View Source 
const (
	// ProductRatePlanProductTypeNonrecurring captures enum value "nonrecurring"
	ProductRatePlanProductTypeNonrecurring string = "nonrecurring"
	// ProductRatePlanProductTypeRecurring captures enum value "recurring"
	ProductRatePlanProductTypeRecurring string = "recurring"
)
View Source 
const (
	// ProductRatePlanTaxStatusInclusive captures enum value "inclusive"
	ProductRatePlanTaxStatusInclusive string = "inclusive"
	// ProductRatePlanTaxStatusExclusive captures enum value "exclusive"
	ProductRatePlanTaxStatusExclusive string = "exclusive"
)
View Source 
const (
	// ProductRatePlanTrialPeriodNone captures enum value "none"
	ProductRatePlanTrialPeriodNone string = "none"
	// ProductRatePlanTrialPeriodMinutes captures enum value "minutes"
	ProductRatePlanTrialPeriodMinutes string = "minutes"
	// ProductRatePlanTrialPeriodDays captures enum value "days"
	ProductRatePlanTrialPeriodDays string = "days"
	// ProductRatePlanTrialPeriodMonths captures enum value "months"
	ProductRatePlanTrialPeriodMonths string = "months"
)
View Source 
const (
	// ReceiptDecisionAccept captures enum value "Accept"
	ReceiptDecisionAccept string = "Accept"
	// ReceiptDecisionReject captures enum value "Reject"
	ReceiptDecisionReject string = "Reject"
	// ReceiptDecisionError captures enum value "Error"
	ReceiptDecisionError string = "Error"
)
View Source 
const (
	// ReceiptInvoiceTypeSubscription captures enum value "Subscription"
	ReceiptInvoiceTypeSubscription string = "Subscription"
	// ReceiptInvoiceTypeTrial captures enum value "Trial"
	ReceiptInvoiceTypeTrial string = "Trial"
	// ReceiptInvoiceTypeCharge captures enum value "Charge"
	ReceiptInvoiceTypeCharge string = "Charge"
	// ReceiptInvoiceTypeFinalArrears captures enum value "FinalArrears"
	ReceiptInvoiceTypeFinalArrears string = "FinalArrears"
	// ReceiptInvoiceTypeAmendment captures enum value "Amendment"
	ReceiptInvoiceTypeAmendment string = "Amendment"
	// ReceiptInvoiceTypeAggregated captures enum value "Aggregated"
	ReceiptInvoiceTypeAggregated string = "Aggregated"
)
View Source 
const (
	// ReceiptPaymentGatewayCybersourceToken captures enum value "cybersource_token"
	ReceiptPaymentGatewayCybersourceToken string = "cybersource_token"
	// ReceiptPaymentGatewayCardVault captures enum value "card_vault"
	ReceiptPaymentGatewayCardVault string = "card_vault"
	// ReceiptPaymentGatewayPaypalSimple captures enum value "paypal_simple"
	ReceiptPaymentGatewayPaypalSimple string = "paypal_simple"
	// ReceiptPaymentGatewayLocustworld captures enum value "locustworld"
	ReceiptPaymentGatewayLocustworld string = "locustworld"
	// ReceiptPaymentGatewayFree captures enum value "free"
	ReceiptPaymentGatewayFree string = "free"
	// ReceiptPaymentGatewayCoupon captures enum value "coupon"
	ReceiptPaymentGatewayCoupon string = "coupon"
	// ReceiptPaymentGatewayCreditNote captures enum value "credit_note"
	ReceiptPaymentGatewayCreditNote string = "credit_note"
	// ReceiptPaymentGatewayStripe captures enum value "stripe"
	ReceiptPaymentGatewayStripe string = "stripe"
	// ReceiptPaymentGatewayBraintree captures enum value "braintree"
	ReceiptPaymentGatewayBraintree string = "braintree"
	// ReceiptPaymentGatewayBalanced captures enum value "balanced"
	ReceiptPaymentGatewayBalanced string = "balanced"
	// ReceiptPaymentGatewayPaypal captures enum value "paypal"
	ReceiptPaymentGatewayPaypal string = "paypal"
	// ReceiptPaymentGatewayBillforwardTest captures enum value "billforward_test"
	ReceiptPaymentGatewayBillforwardTest string = "billforward_test"
	// ReceiptPaymentGatewayOffline captures enum value "offline"
	ReceiptPaymentGatewayOffline string = "offline"
	// ReceiptPaymentGatewayTrial captures enum value "trial"
	ReceiptPaymentGatewayTrial string = "trial"
	// ReceiptPaymentGatewayStripeACH captures enum value "stripeACH"
	ReceiptPaymentGatewayStripeACH string = "stripeACH"
	// ReceiptPaymentGatewayAuthorizeNet captures enum value "authorizeNet"
	ReceiptPaymentGatewayAuthorizeNet string = "authorizeNet"
	// ReceiptPaymentGatewaySpreedly captures enum value "spreedly"
	ReceiptPaymentGatewaySpreedly string = "spreedly"
	// ReceiptPaymentGatewaySagePay captures enum value "sagePay"
	ReceiptPaymentGatewaySagePay string = "sagePay"
	// ReceiptPaymentGatewayTrustCommerce captures enum value "trustCommerce"
	ReceiptPaymentGatewayTrustCommerce string = "trustCommerce"
	// ReceiptPaymentGatewayPayvision captures enum value "payvision"
	ReceiptPaymentGatewayPayvision string = "payvision"
	// ReceiptPaymentGatewayKash captures enum value "kash"
	ReceiptPaymentGatewayKash string = "kash"
)
View Source 
const (
	// ReceiptTypeCredit captures enum value "credit"
	ReceiptTypeCredit string = "credit"
	// ReceiptTypeDebit captures enum value "debit"
	ReceiptTypeDebit string = "debit"
)
View Source 
const (
	// RefundRefundNatureRefund captures enum value "Refund"
	RefundRefundNatureRefund string = "Refund"
	// RefundRefundNatureVoid captures enum value "Void"
	RefundRefundNatureVoid string = "Void"
)
View Source 
const (
	// RefundRefundStatePending captures enum value "Pending"
	RefundRefundStatePending string = "Pending"
	// RefundRefundStateAwaitingRefund captures enum value "AwaitingRefund"
	RefundRefundStateAwaitingRefund string = "AwaitingRefund"
	// RefundRefundStateRefunded captures enum value "Refunded"
	RefundRefundStateRefunded string = "Refunded"
	// RefundRefundStateCancelled captures enum value "Cancelled"
	RefundRefundStateCancelled string = "Cancelled"
	// RefundRefundStateFailed captures enum value "Failed"
	RefundRefundStateFailed string = "Failed"
)
View Source 
const (
	// RefundRefundTypeInvoicePayment captures enum value "InvoicePayment"
	RefundRefundTypeInvoicePayment string = "InvoicePayment"
	// RefundRefundTypePayment captures enum value "Payment"
	RefundRefundTypePayment string = "Payment"
)
View Source 
const (
	// SubscriptionFailedPaymentBehaviourCancelSubscription captures enum value "CancelSubscription"
	SubscriptionFailedPaymentBehaviourCancelSubscription string = "CancelSubscription"
	// SubscriptionFailedPaymentBehaviourNone captures enum value "None"
	SubscriptionFailedPaymentBehaviourNone string = "None"
)
View Source 
const (
	// SubscriptionManagedByBillForward captures enum value "BillForward"
	SubscriptionManagedByBillForward string = "BillForward"
	// SubscriptionManagedByStripe captures enum value "Stripe"
	SubscriptionManagedByStripe string = "Stripe"
)
View Source 
const (
	// SubscriptionStateTrial captures enum value "Trial"
	SubscriptionStateTrial string = "Trial"
	// SubscriptionStateProvisioned captures enum value "Provisioned"
	SubscriptionStateProvisioned string = "Provisioned"
	// SubscriptionStatePaid captures enum value "Paid"
	SubscriptionStatePaid string = "Paid"
	// SubscriptionStateAwaitingPayment captures enum value "AwaitingPayment"
	SubscriptionStateAwaitingPayment string = "AwaitingPayment"
	// SubscriptionStateCancelled captures enum value "Cancelled"
	SubscriptionStateCancelled string = "Cancelled"
	// SubscriptionStateFailed captures enum value "Failed"
	SubscriptionStateFailed string = "Failed"
	// SubscriptionStateExpired captures enum value "Expired"
	SubscriptionStateExpired string = "Expired"
)
View Source 
const (
	// SubscriptionTypeSubscription captures enum value "Subscription"
	SubscriptionTypeSubscription string = "Subscription"
	// SubscriptionTypeFixedTerm captures enum value "FixedTerm"
	SubscriptionTypeFixedTerm string = "FixedTerm"
	// SubscriptionTypeTrial captures enum value "Trial"
	SubscriptionTypeTrial string = "Trial"
)
View Source 
const (
	// SubscriptionChargeChargeTypeCredit captures enum value "Credit"
	SubscriptionChargeChargeTypeCredit string = "Credit"
	// SubscriptionChargeChargeTypeDebit captures enum value "Debit"
	SubscriptionChargeChargeTypeDebit string = "Debit"
)
View Source 
const (
	// SubscriptionChargeInvoicingTypeImmediate captures enum value "Immediate"
	SubscriptionChargeInvoicingTypeImmediate string = "Immediate"
	// SubscriptionChargeInvoicingTypeAggregated captures enum value "Aggregated"
	SubscriptionChargeInvoicingTypeAggregated string = "Aggregated"
)
View Source 
const (
	// SubscriptionChargeRemainingCreditBehaviourRollover captures enum value "Rollover"
	SubscriptionChargeRemainingCreditBehaviourRollover string = "Rollover"
	// SubscriptionChargeRemainingCreditBehaviourDiscard captures enum value "Discard"
	SubscriptionChargeRemainingCreditBehaviourDiscard string = "Discard"
)
View Source 
const (
	// SubscriptionChargeStateVoided captures enum value "Voided"
	SubscriptionChargeStateVoided string = "Voided"
	// SubscriptionChargeStatePending captures enum value "Pending"
	SubscriptionChargeStatePending string = "Pending"
	// SubscriptionChargeStateAwaitingPayment captures enum value "AwaitingPayment"
	SubscriptionChargeStateAwaitingPayment string = "AwaitingPayment"
	// SubscriptionChargeStatePaid captures enum value "Paid"
	SubscriptionChargeStatePaid string = "Paid"
	// SubscriptionChargeStateFailed captures enum value "Failed"
	SubscriptionChargeStateFailed string = "Failed"
)
View Source 
const (
	// SubscriptionChargeTypeSetup captures enum value "Setup"
	SubscriptionChargeTypeSetup string = "Setup"
	// SubscriptionChargeTypeUpgrade captures enum value "Upgrade"
	SubscriptionChargeTypeUpgrade string = "Upgrade"
	// SubscriptionChargeTypeManual captures enum value "Manual"
	SubscriptionChargeTypeManual string = "Manual"
	// SubscriptionChargeTypeProductRatePlanMigration captures enum value "ProductRatePlanMigration"
	SubscriptionChargeTypeProductRatePlanMigration string = "ProductRatePlanMigration"
	// SubscriptionChargeTypeArrears captures enum value "Arrears"
	SubscriptionChargeTypeArrears string = "Arrears"
	// SubscriptionChargeTypeAdvance captures enum value "Advance"
	SubscriptionChargeTypeAdvance string = "Advance"
	// SubscriptionChargeTypeCoupon captures enum value "Coupon"
	SubscriptionChargeTypeCoupon string = "Coupon"
	// SubscriptionChargeTypeUsage captures enum value "Usage"
	SubscriptionChargeTypeUsage string = "Usage"
	// SubscriptionChargeTypePricingComponent captures enum value "PricingComponent"
	SubscriptionChargeTypePricingComponent string = "PricingComponent"
)
View Source 
const (
	// TimeRequestExecutionStrategySingleAttempt captures enum value "SingleAttempt"
	TimeRequestExecutionStrategySingleAttempt string = "SingleAttempt"
	// TimeRequestExecutionStrategyFollowDunning captures enum value "FollowDunning"
	TimeRequestExecutionStrategyFollowDunning string = "FollowDunning"
	// TimeRequestExecutionStrategyNone captures enum value "None"
	TimeRequestExecutionStrategyNone string = "None"
)
View Source 
const (
	// TimeResponseExecutionStrategySingleAttempt captures enum value "SingleAttempt"
	TimeResponseExecutionStrategySingleAttempt string = "SingleAttempt"
	// TimeResponseExecutionStrategyFollowDunning captures enum value "FollowDunning"
	TimeResponseExecutionStrategyFollowDunning string = "FollowDunning"
	// TimeResponseExecutionStrategyNone captures enum value "None"
	TimeResponseExecutionStrategyNone string = "None"
)
View Source 
const (
	// UpdateSubscriptionRequestFailedPaymentBehaviourCancelSubscription captures enum value "CancelSubscription"
	UpdateSubscriptionRequestFailedPaymentBehaviourCancelSubscription string = "CancelSubscription"
	// UpdateSubscriptionRequestFailedPaymentBehaviourNone captures enum value "None"
	UpdateSubscriptionRequestFailedPaymentBehaviourNone string = "None"
)
View Source 
const (
	// UpdateSubscriptionRequestStateTrial captures enum value "Trial"
	UpdateSubscriptionRequestStateTrial string = "Trial"
	// UpdateSubscriptionRequestStateProvisioned captures enum value "Provisioned"
	UpdateSubscriptionRequestStateProvisioned string = "Provisioned"
	// UpdateSubscriptionRequestStatePaid captures enum value "Paid"
	UpdateSubscriptionRequestStatePaid string = "Paid"
	// UpdateSubscriptionRequestStateAwaitingPayment captures enum value "AwaitingPayment"
	UpdateSubscriptionRequestStateAwaitingPayment string = "AwaitingPayment"
	// UpdateSubscriptionRequestStateCancelled captures enum value "Cancelled"
	UpdateSubscriptionRequestStateCancelled string = "Cancelled"
	// UpdateSubscriptionRequestStateFailed captures enum value "Failed"
	UpdateSubscriptionRequestStateFailed string = "Failed"
	// UpdateSubscriptionRequestStateExpired captures enum value "Expired"
	UpdateSubscriptionRequestStateExpired string = "Expired"
)
View Source 
const (
	// MutableBillingEntityTargetSalesforce captures enum value "Salesforce"
	MutableBillingEntityTargetSalesforce string = "Salesforce"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Account 

type Account struct {

	// { "description" : "If present, this will be the product rate plan to use when creating an aggregating subscription.  An account level aggregating subscription will be created when the first subscription is created against the account.", "verbs":[] }
	AggregatingProductRatePlanID string `json:"aggregatingProductRatePlanID,omitempty"`

	// { "description" : "The consistent ID of the account level aggregating subscription, if one exists.", "verbs":[] }
	AggregatingSubscriptionID string `json:"aggregatingSubscriptionID,omitempty"`

	// { "description" : "ID of the user who last updated the entity.", "verbs":[] }
	ChangedBy string `json:"changedBy,omitempty"`

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`

	// { "description" : "CRM ID of the account.", "verbs":["GET"] }
	CrmID string `json:"crmID,omitempty"`

	// {  "default" : "false",  "description" : "Indicates if an account has been retired. If an account has been retired it can still be retrieved using the appropriate flag on API requests.", "verbs":["GET"] }
	Deleted *bool `json:"deleted,omitempty"`

	// { "description" : "ID of the account.", "verbs":["GET"] }
	// Required: true
	ID *string `json:"id"`

	// { "description" : "Add metadata.", "verbs":["POST"] }
	Metadata DynamicMetadata `json:"metadata,omitempty"`

	// { "description" : "Organization associated with the account.", "verbs":[] }
	// Required: true
	OrganizationID *string `json:"organizationID"`

	// { "description" : "The payment-methods associated with the account.", "verbs":["GET"] }
	PaymentMethods []*PaymentMethod `json:"paymentMethods"`

	// profile
	Profile *Profile `json:"profile,omitempty"`

	// { "description" : "Number of distinct, paid subscriptions associated with this account. Initially the value will be 0 when no successful subscriptions have been taken. A subscription cancelled whilst in trial is counted as successful.", "verbs":["GET"] }
	SuccessfulSubscriptions int32 `json:"successfulSubscriptions,omitempty"`

	// { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }
	Updated strfmt.DateTime `json:"updated,omitempty"`

	// { "description" : "User associated with the account. If this is null, no user is currently assocaited with the account. A user is only set when an account is associated with a user account.", "verbs":[] }
	UserID string `json:"userID,omitempty"`
}

Account Account swagger:model Account

func (*Account) Validate 

func (m *Account) Validate(formats strfmt.Registry) error

Validate validates this account

type AccountPagedMetadata 

type AccountPagedMetadata struct {

	// {"description":"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.","verbs":["GET","PUT","POST"]}
	// Required: true
	CurrentOffset *int32 `json:"currentOffset"`

	// {"description":"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.","verbs":["GET","PUT","POST"]}
	// Required: true
	CurrentPage *int32 `json:"currentPage"`

	// {"description":"Number of milliseconds taken by API to calculate response.","verbs":["GET","PUT","POST"]}
	// Required: true
	ExecutionTime *int64 `json:"executionTime"`

	// {"description":"Paging parameter. URL fragment that can be used to fetch next page of results.","verbs":["GET","PUT","POST"]}
	// Required: true
	NextPage *string `json:"nextPage"`

	// {"default":10,"description":"Paging parameter. Describes how many records you requested.","verbs":["GET","PUT","POST"]}
	// Required: true
	RecordsRequested *int32 `json:"recordsRequested"`

	// {"description":"Describes how many records were returned by your query.","verbs":["GET","PUT","POST"]}
	// Required: true
	RecordsReturned *int32 `json:"recordsReturned"`

	// {"description":"The results returned by your query.","verbs":["GET","PUT","POST"]}
	// Required: true
	Results []*Account `json:"results"`
}

AccountPagedMetadata account paged metadata swagger:model AccountPagedMetadata

func (*AccountPagedMetadata) Validate 

func (m *AccountPagedMetadata) Validate(formats strfmt.Registry) error

Validate validates this account paged metadata

type AddPaymentMethodRequest 

type AddPaymentMethodRequest struct {

	// { "description" : "ID of the payment method to add", "verbs":["POST","GET"] }
	ID string `json:"id,omitempty"`
}

AddPaymentMethodRequest AddPaymentMethodRequest swagger:model AddPaymentMethodRequest

func (*AddPaymentMethodRequest) Validate 

func (m *AddPaymentMethodRequest) Validate(formats strfmt.Registry) error

Validate validates this add payment method request

type Address 

type Address struct {

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	// Required: true
	AddressLine1 *string `json:"addressLine1"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	AddressLine2 string `json:"addressLine2,omitempty"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	AddressLine3 string `json:"addressLine3,omitempty"`

	// { "description" : "ID of the user who last updated the entity.", "verbs":[] }
	ChangedBy string `json:"changedBy,omitempty"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	// Required: true
	City *string `json:"city"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	// Required: true
	Country *string `json:"country"`

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`

	// { "description" : "", "verbs":["GET"] }
	Deleted *bool `json:"deleted,omitempty"`

	// { "description" : "", "verbs":["PUT","GET"] }
	ID string `json:"id,omitempty"`

	// { "description" : "Phone number", "verbs":["POST","PUT","GET"] }
	Landline string `json:"landline,omitempty"`

	// { "description" : "", "verbs":[] }
	OrganizationID string `json:"organizationID,omitempty"`

	// { "description" : "ZIP code or postcode.", "verbs":["POST","PUT","GET"] }
	// Required: true
	Postcode *string `json:"postcode"`

	// { "description" : "Is this the primary, default, address for the associated profile?", "verbs":["POST","PUT","GET"] }
	PrimaryAddress *bool `json:"primaryAddress,omitempty"`

	// { "description" : "", "verbs":["GET"] }
	ProfileID string `json:"profileID,omitempty"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	// Required: true
	Province *string `json:"province"`

	// { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }
	Updated strfmt.DateTime `json:"updated,omitempty"`
}

Address Address swagger:model Address

func (*Address) Validate 

func (m *Address) Validate(formats strfmt.Registry) error

Validate validates this address

type AddressPagedMetadata 

type AddressPagedMetadata struct {

	// {"description":"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.","verbs":["GET","PUT","POST"]}
	// Required: true
	CurrentOffset *int32 `json:"currentOffset"`

	// {"description":"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.","verbs":["GET","PUT","POST"]}
	// Required: true
	CurrentPage *int32 `json:"currentPage"`

	// {"description":"Number of milliseconds taken by API to calculate response.","verbs":["GET","PUT","POST"]}
	// Required: true
	ExecutionTime *int64 `json:"executionTime"`

	// {"description":"Paging parameter. URL fragment that can be used to fetch next page of results.","verbs":["GET","PUT","POST"]}
	// Required: true
	NextPage *string `json:"nextPage"`

	// {"default":10,"description":"Paging parameter. Describes how many records you requested.","verbs":["GET","PUT","POST"]}
	// Required: true
	RecordsRequested *int32 `json:"recordsRequested"`

	// {"description":"Describes how many records were returned by your query.","verbs":["GET","PUT","POST"]}
	// Required: true
	RecordsReturned *int32 `json:"recordsReturned"`

	// {"description":"The results returned by your query.","verbs":["GET","PUT","POST"]}
	// Required: true
	Results []*Address `json:"results"`
}

AddressPagedMetadata address paged metadata swagger:model AddressPagedMetadata

func (*AddressPagedMetadata) Validate 

func (m *AddressPagedMetadata) Validate(formats strfmt.Registry) error

Validate validates this address paged metadata

type AggregatingComponent 

type AggregatingComponent struct {

	// { "description" : "ID of the user who last updated the entity.", "verbs":[] }
	ChangedBy string `json:"changedBy,omitempty"`

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`

	// {"default":false,"description":"Whether the AggregatingComponent has been retired.","verbs":["GET"]}
	Deleted *bool `json:"deleted,omitempty"`

	// {"description":"Unique ID by which the AggregatingComponent can be looked up.","verbs":["GET"]}
	ID string `json:"id,omitempty"`

	// {"default":"(Auto-populated using your authentication credentials)","description":"ID of the BillForward Organization within which the requested pricing component should be created. If omitted: this will be auto-populated using your authentication credentials.","verbs":["POST","GET"]}
	OrganizationID string `json:"organizationID,omitempty"`

	// {"description":"ID of the pricing component to which this AggregatingComponent's aggregation applies. The subscriber to the aggregating rate plan (which contains this AggregatingComponent), will consult its children at the end of each billing period, and collect from those children all charges whose pricing component matches this ID. Those charges' quantities will be counted, and used when calculating the price of consuming this AggregatingComponent. The aggregating subscription then raises a discount charge — to account for the more favourable price tiering that emerges when aggregating.","verbs":["POST"]}
	// Required: true
	PricingComponentID *string `json:"pricingComponentID"`

	// {"description":"Name of the pricing component to which this AggregatingComponent's aggregation applies. The subscriber to the aggregating rate plan (which contains this AggregatingComponent), will consult its children at the end of each billing period, and collect from those children all charges whose pricing component matches this ID. Those charges' quantities will be counted, and used when calculating the price of consuming this AggregatingComponent. The aggregating subscription then raises a discount charge — to account for the more favourable price tiering that emerges when aggregating.","verbs":["POST"]}
	// Required: true
	PricingComponentName *string `json:"pricingComponentName"`

	// {"description":"ID of the rate plan upon which this AggregatingComponent is defined.","verbs":["POST","GET"]}
	ProductRatePlanID string `json:"productRatePlanID,omitempty"`

	// {"description":"Name of the rate plan upon which this AggregatingComponent is defined.","verbs":["POST","GET"]}
	ProductRatePlanName string `json:"productRatePlanName,omitempty"`

	// { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }
	Updated strfmt.DateTime `json:"updated,omitempty"`
}

AggregatingComponent The aggregating component defines a component which should be re-priced upon invoice aggregation swagger:model AggregatingComponent

func (*AggregatingComponent) Validate 

func (m *AggregatingComponent) Validate(formats strfmt.Registry) error

Validate validates this aggregating component

type Alias 

type Alias struct {

	// { "description" : "A string representation of the alias.", "verbs":["POST","PUT","GET"] }
	// Required: true
	Alias *string `json:"alias"`

	// { "description" : "ID of the user who last updated the entity.", "verbs":[] }
	ChangedBy string `json:"changedBy,omitempty"`

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`

	// { "description" : "Has this alias been deleted?", "verbs":["POST","PUT","GET"] }
	// Required: true
	Deleted bool `json:"deleted"`

	// { "description" : "ID of the alias.", "verbs":["POST","PUT","GET"] }
	// Required: true
	ID *string `json:"id"`

	// { "description" : "ID of the organization associated with the alias.", "verbs":["POST","PUT","GET"] }
	// Required: true
	OrganizationID *string `json:"organizationID"`

	// { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }
	Updated strfmt.DateTime `json:"updated,omitempty"`
}

Alias The alias used to encrypt card details swagger:model Alias

func (*Alias) Validate 

func (m *Alias) Validate(formats strfmt.Registry) error

Validate validates this alias

type AuthCaptureRequest 

type AuthCaptureRequest interface {
	runtime.Validatable

	// at type
	// Required: true
	AtType() string
	SetAtType(string)

	// {"description":"ID of the BillForward Account with which you would like to associate the created payment method.<br>If omitted, BillForward will associate the created PaymentMethod with a newly-created Account, whose Profile details will be populated using billing information from the funding instrument.","verbs":["POST"]}
	AccountID() string
	SetAccountID(string)

	// {"description":"The name of the company of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile &mdash; should a BillForward Account be created by this request.","verbs":["POST"]}
	CompanyName() string
	SetCompanyName(string)

	// {"default":false,"description":"Whether the PaymentMethod produced by this request should be elected as the 'default' payment method for the concerned BillForward Account. Whichever PaymentMethod is elected as an Account's default payment method, will be consulted whenever payment is demanded of that Account (i.e. upon the execution of any of the Account's invoices).","verbs":["POST"]}
	DefaultPaymentMethod() *bool
	SetDefaultPaymentMethod(*bool)

	// {"description":"The email address of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile &mdash; should a BillForward Account be created by this request.","verbs":["POST"]}
	Email() string
	SetEmail(string)

	// {"description":"The first name of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile &mdash; should a BillForward Account be created by this request.","verbs":["POST"]}
	FirstName() string
	SetFirstName(string)

	// {"description":"The gateway with which your funding instrument has been vaulted.","verbs":["POST"]}
	Gateway() string
	SetGateway(string)

	// {"description":"The last name of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile &mdash; should a BillForward Account be created by this request.","verbs":["POST"]}
	LastName() string
	SetLastName(string)

	// {"description":"The mobile phone number of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile &mdash; should a BillForward Account be created by this request.","verbs":["POST"]}
	Mobile() string
	SetMobile(string)

	// {"description":"ID of the BillForward Organization within which the requested PaymentMethod should be created. If omitted, this will be auto-populated using your authentication credentials.","verbs":["POST"]}
	OrganizationID() string
	SetOrganizationID(string)
}

AuthCaptureRequest [Note: this request can be built automatically by our client-side card capture library, <a href="https://github.com/billforward/billforward-js">BillForward.js</a>; you should not need to interact with this API manually unless you have particularly bespoke requirements] This entity is used for requesting that BillForward produce a PaymentMethod, linked to a funding instrument you have vaulted in some payment gateway. The BillForward PaymentMethod will be associated with a BillForward Account of your choosing (or a newly-created Account, if preferred). swagger:discriminator AuthCaptureRequest @type

func UnmarshalAuthCaptureRequest 

func UnmarshalAuthCaptureRequest(reader io.Reader, consumer runtime.Consumer) (AuthCaptureRequest, error)

UnmarshalAuthCaptureRequest unmarshals polymorphic AuthCaptureRequest

func UnmarshalAuthCaptureRequestSlice 

func UnmarshalAuthCaptureRequestSlice(reader io.Reader, consumer runtime.Consumer) ([]AuthCaptureRequest, error)

UnmarshalAuthCaptureRequestSlice unmarshals polymorphic slices of AuthCaptureRequest

type BFError 

type BFError struct {

	// {"description":"Code describing the nature of the error. Currently unused; prefer `errorType`.","verbs":["GET","PUT","POST"]}
	ErrorCode int32 `json:"errorCode,omitempty"`

	// {"description":"Human-readable description of the reason for the error.","verbs":["GET","PUT","POST"]}
	ErrorMessage string `json:"errorMessage,omitempty"`

	// {"description":"List of erroneous parameters found in your input (if applicable).","verbs":["GET","PUT","POST"]}
	ErrorParameters []string `json:"errorParameters"`

	// {"description":"Enum categorizing the nature of the error.","verbs":["GET","PUT","POST"]}
	ErrorType string `json:"errorType,omitempty"`
}

BFError Standard BillForward error format. swagger:model BFError

func (*BFError) Validate 

func (m *BFError) Validate(formats strfmt.Registry) error

Validate validates this b f error

type BillingEntityBase 

type BillingEntityBase struct {

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`
}

BillingEntityBase Billing entities are models in the BillForward system, of objects in the real-world or otherwise. swagger:model BillingEntityBase

func (*BillingEntityBase) Validate 

func (m *BillingEntityBase) Validate(formats strfmt.Registry) error

Validate validates this billing entity base

type BraintreeAuthCaptureRequest 

type BraintreeAuthCaptureRequest struct {

	// {"description":"(Required when vaulting a PayPal payment method; otherwise optional)<br>A JSON string providing information about the device your customer used to fill out the card capture form. This information is inserted into your form by <a href=\"https://developers.braintreepayments.com/javascript+node/guides/advanced-fraud-tools/client-side\">braintree-data.js</a> &mdash; if and only if you use Braintree's drop-in form integrations. You should ideally provide it if you have one (it aids with fraud detection), but it is only mandatory in the case of PayPal payment method vaulting.","verbs":["POST"]}
	DeviceData string `json:"deviceData,omitempty"`

	// {"description":"One-use cryptographic nonce <a href=\"https://developers.braintreepayments.com/javascript+node/start/overview\">provided by Braintree's client-side card capture SDK</a>, in response to your capturing a card into the Braintree vault. This nonce will be used by BillForward to find the tokenized card within the Braintree vault &mdash; precursory to linking a BillForward PaymentMethod to that tokenized card","verbs":["POST"]}
	// Required: true
	PaymentMethodNonce *string `json:"paymentMethodNonce"`
	// contains filtered or unexported fields
}

BraintreeAuthCaptureRequest braintree auth capture request swagger:model BraintreeAuthCaptureRequest

func (*BraintreeAuthCaptureRequest) AccountID 

func (m *BraintreeAuthCaptureRequest) AccountID() string

func (*BraintreeAuthCaptureRequest) AtType 

func (m *BraintreeAuthCaptureRequest) AtType() string

func (*BraintreeAuthCaptureRequest) CompanyName 

func (m *BraintreeAuthCaptureRequest) CompanyName() string

func (*BraintreeAuthCaptureRequest) DefaultPaymentMethod 

func (m *BraintreeAuthCaptureRequest) DefaultPaymentMethod() *bool

func (*BraintreeAuthCaptureRequest) Email 

func (m *BraintreeAuthCaptureRequest) Email() string

func (*BraintreeAuthCaptureRequest) FirstName 

func (m *BraintreeAuthCaptureRequest) FirstName() string

func (*BraintreeAuthCaptureRequest) Gateway 

func (m *BraintreeAuthCaptureRequest) Gateway() string

func (*BraintreeAuthCaptureRequest) LastName 

func (m *BraintreeAuthCaptureRequest) LastName() string

func (BraintreeAuthCaptureRequest) MarshalJSON 

func (m BraintreeAuthCaptureRequest) MarshalJSON() ([]byte, error)

MarshalJSON marshals this polymorphic type to a JSON structure

func (*BraintreeAuthCaptureRequest) Mobile 

func (m *BraintreeAuthCaptureRequest) Mobile() string

func (*BraintreeAuthCaptureRequest) OrganizationID 

func (m *BraintreeAuthCaptureRequest) OrganizationID() string

func (*BraintreeAuthCaptureRequest) SetAccountID 

func (m *BraintreeAuthCaptureRequest) SetAccountID(val string)

func (*BraintreeAuthCaptureRequest) SetAtType 

func (m *BraintreeAuthCaptureRequest) SetAtType(val string)

func (*BraintreeAuthCaptureRequest) SetCompanyName 

func (m *BraintreeAuthCaptureRequest) SetCompanyName(val string)

func (*BraintreeAuthCaptureRequest) SetDefaultPaymentMethod 

func (m *BraintreeAuthCaptureRequest) SetDefaultPaymentMethod(val *bool)

func (*BraintreeAuthCaptureRequest) SetEmail 

func (m *BraintreeAuthCaptureRequest) SetEmail(val string)

func (*BraintreeAuthCaptureRequest) SetFirstName 

func (m *BraintreeAuthCaptureRequest) SetFirstName(val string)

func (*BraintreeAuthCaptureRequest) SetGateway 

func (m *BraintreeAuthCaptureRequest) SetGateway(val string)

func (*BraintreeAuthCaptureRequest) SetLastName 

func (m *BraintreeAuthCaptureRequest) SetLastName(val string)

func (*BraintreeAuthCaptureRequest) SetMobile 

func (m *BraintreeAuthCaptureRequest) SetMobile(val string)

func (*BraintreeAuthCaptureRequest) SetOrganizationID 

func (m *BraintreeAuthCaptureRequest) SetOrganizationID(val string)

func (*BraintreeAuthCaptureRequest) UnmarshalJSON 

func (m *BraintreeAuthCaptureRequest) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this polymorphic type from a JSON structure

func (*BraintreeAuthCaptureRequest) Validate 

func (m *BraintreeAuthCaptureRequest) Validate(formats strfmt.Registry) error

Validate validates this braintree auth capture request

type CancelSubscriptionRequest 

type CancelSubscriptionRequest struct {

	// cancel children
	CancelChildren bool `json:"cancelChildren,omitempty"`

	// cancel empty parent
	CancelEmptyParent bool `json:"cancelEmptyParent,omitempty"`

	// Specifies whether the service will end immediately on cancellation or if it will continue until the end of the current period. Default: AtPeriodEnd
	CancellationCredit string `json:"cancellationCredit,omitempty"`

	// service end
	ServiceEnd string `json:"serviceEnd,omitempty"`

	// source
	// Required: true
	Source *string `json:"source"`

	// state
	State string `json:"state,omitempty"`

	// subscription ID
	// Required: true
	SubscriptionID *string `json:"subscriptionID"`
}

CancelSubscriptionRequest CancelSubscriptionRequest swagger:model CancelSubscriptionRequest

func (*CancelSubscriptionRequest) Validate 

func (m *CancelSubscriptionRequest) Validate(formats strfmt.Registry) error

Validate validates this cancel subscription request

type Client 

type Client struct {

	// { "description" : "The amount of time in seconds that an access token for the client is valid.", "verbs":["POST","PUT","GET"] }
	// Required: true
	AccessTokenValiditySeconds *int32 `json:"accessTokenValiditySeconds"`

	// { "description" : "Authorities associated with the client.", "verbs":["POST","PUT","GET"] }
	// Required: true
	Authorities *string `json:"authorities"`

	// { "description" : "Oauth2 Grant Types which may be used when authenticating with the client.", "verbs":["POST","PUT","GET"] }
	// Required: true
	AuthorizedGrantTypes *string `json:"authorizedGrantTypes"`

	// { "description" : "ID of the user who last updated the entity.", "verbs":[] }
	ChangedBy string `json:"changedBy,omitempty"`

	// { "description" : "ID of the OAuth2 client.", "verbs":["POST","PUT","GET"] }
	ClientID string `json:"clientId,omitempty"`

	// { "description" : "Unique Client Secret of the client. This is used as the OAuth2 Client secret", "verbs":["POST","PUT","GET"] }
	// Required: true
	ClientSecret *string `json:"clientSecret"`

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`

	// { "description" : "Indicates if a client has been retired. If a client has been retired it can still be retrieved using the appropriate flag on API requests.", "verbs":["POST","PUT","GET"] }
	// Required: true
	Deleted bool `json:"deleted"`

	// { "description" : "Organization associated with the client.", "verbs":["POST","PUT","GET"] }
	// Required: true
	OrganizationID *string `json:"organizationID"`

	// { "description" : "The amount of time in seconds that a refresh token for the client is valid.", "verbs":["POST","PUT","GET"] }
	// Required: true
	RefreshTokenValiditySeconds *int32 `json:"refreshTokenValiditySeconds"`

	// { "description" : "Registered Redirect URIs associated with the client.", "verbs":["POST","PUT","GET"] }
	// Required: true
	RegisteredRedirectUris *string `json:"registeredRedirectUris"`

	// { "description" : "Resources associated with the client.", "verbs":["POST","PUT","GET"] }
	// Required: true
	ResourceIds *string `json:"resourceIds"`

	// { "description" : "Scopes associated with the client.", "verbs":["POST","PUT","GET"] }
	// Required: true
	Scope *string `json:"scope"`

	// { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }
	Updated strfmt.DateTime `json:"updated,omitempty"`
}

Client An oAuth2 client with which BillForward users may authenticate. swagger:model Client

func (*Client) Validate 

func (m *Client) Validate(formats strfmt.Registry) error

Validate validates this client

type CreateAccountProfileRequest 

type CreateAccountProfileRequest struct {

	// { "description" : "", "verbs":["GET"] }
	AccountID string `json:"accountID,omitempty"`

	// { "description" : "Any additional information", "verbs":["POST","PUT","GET"] }
	AdditionalInformation string `json:"additionalInformation,omitempty"`

	// { "description" : "Address associated with the profile", "verbs":["POST","PUT","GET"] }
	Addresses []*CreateProfileAddressRequest `json:"addresses"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	CompanyName string `json:"companyName,omitempty"`

	// { "description" : "Date of birth in YYYY-MM-DD format", "verbs":["POST","PUT","GET"] }
	Dob *strfmt.DateTime `json:"dob,omitempty"`

	// { "description" : "E-mail address", "verbs":["POST","PUT","GET"] }
	Email string `json:"email,omitempty"`

	// { "description" : "Fax number", "verbs":["POST","PUT","GET"] }
	Fax string `json:"fax,omitempty"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	FirstName string `json:"firstName,omitempty"`

	// { "description" : "Home telephone number", "verbs":["POST","PUT","GET"] }
	Landline string `json:"landline,omitempty"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	LastName string `json:"lastName,omitempty"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	LogoURL string `json:"logoURL,omitempty"`

	// { "description" : "Mobile telephone number", "verbs":["POST","PUT","GET"] }
	Mobile string `json:"mobile,omitempty"`

	// { "description" : "VAT number", "verbs":["POST","PUT","GET"] }
	VatNumber string `json:"vatNumber,omitempty"`
}

CreateAccountProfileRequest create account profile request swagger:model CreateAccountProfileRequest

func (*CreateAccountProfileRequest) Validate 

func (m *CreateAccountProfileRequest) Validate(formats strfmt.Registry) error

Validate validates this create account profile request

type CreateAccountRequest 

type CreateAccountRequest struct {

	// { "description" : "If present, this will be the product rate plan to use when creating an aggregating subscription.  An account level aggregating subscription will be created when the first subscription is created against the account.", "verbs":[] }
	AggregatingProductRatePlanID string `json:"aggregatingProductRatePlanID,omitempty"`

	// { "description" : "The consistent ID of the account level aggregating subscription, if one exists.", "verbs":[] }
	AggregatingSubscriptionID string `json:"aggregatingSubscriptionID,omitempty"`

	// metadata
	Metadata DynamicMetadata `json:"metadata,omitempty"`

	// { "description" : "Organization associated with the account.", "verbs":[] }
	OrganizationID string `json:"organizationID,omitempty"`

	// profile
	Profile *CreateAccountProfileRequest `json:"profile,omitempty"`

	// { "description" : "User associated with the account. If this is null, no user is currently assocaited with the account. A user is only set when an account is associated with a user account.", "verbs":[] }
	UserID string `json:"userID,omitempty"`
}

CreateAccountRequest CreateAccountRequest swagger:model CreateAccountRequest

func (*CreateAccountRequest) Validate 

func (m *CreateAccountRequest) Validate(formats strfmt.Registry) error

Validate validates this create account request

type CreateAddressRequest 

type CreateAddressRequest struct {

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	// Required: true
	AddressLine1 *string `json:"addressLine1"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	AddressLine2 string `json:"addressLine2,omitempty"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	AddressLine3 string `json:"addressLine3,omitempty"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	// Required: true
	City *string `json:"city"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	// Required: true
	Country *string `json:"country"`

	// { "description" : "Phone number", "verbs":["POST","PUT","GET"] }
	Landline string `json:"landline,omitempty"`

	// { "description" : "ZIP code or postcode.", "verbs":["POST","PUT","GET"] }
	// Required: true
	Postcode *string `json:"postcode"`

	// { "description" : "Is this the primary, default, address for the associated profile?", "verbs":["POST","PUT","GET"] }
	PrimaryAddress *bool `json:"primaryAddress,omitempty"`

	// { "description" : "", "verbs":["GET"] }
	// Required: true
	ProfileID *string `json:"profileID"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	// Required: true
	Province *string `json:"province"`
}

CreateAddressRequest CreateAddressRequest swagger:model CreateAddressRequest

func (*CreateAddressRequest) Validate 

func (m *CreateAddressRequest) Validate(formats strfmt.Registry) error

Validate validates this create address request

type CreateAggregatingComponentRequest 

type CreateAggregatingComponentRequest struct {

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`

	// {"default":"(Auto-populated using your authentication credentials)","description":"ID of the BillForward Organization within which the requested pricing component should be created. If omitted: this will be auto-populated using your authentication credentials.","verbs":["POST"]}
	OrganizationID string `json:"organizationID,omitempty"`

	// {"description":"Name of the pricing component upon which to aggregate. The subscriber to the aggregating rate plan (which contains the AggregatingComponent specified here), will consult its children at the end of each billing period, and collect from those children all charges whose pricing component matches the ID of the component identified here. Those charges' quantities will be counted, and used when calculating the price of consuming this AggregatingComponent. The aggregating subscription then raises a discount charge &mdash; to account for the more favourable price tiering that emerges when aggregating.","verbs":["POST"]}
	// Required: true
	PricingComponent *string `json:"pricingComponent"`
}

CreateAggregatingComponentRequest Entity for requesting that an 'aggregating component' (i.e. a component which should be re-priced upon invoice aggregation) be created. swagger:model CreateAggregatingComponentRequest

func (*CreateAggregatingComponentRequest) Validate 

func (m *CreateAggregatingComponentRequest) Validate(formats strfmt.Registry) error

Validate validates this create aggregating component request

type CreateAggregatingSubscriptionRequest 

type CreateAggregatingSubscriptionRequest struct {

	// {"description":"ID of the BillForward Account who will own this aggregating subscription. You should ensure beforehand that the customer has had a BillForward Account created for them.","verbs":["POST"]}
	// Required: true
	AccountID *string `json:"accountID"`

	// {"default":false,"description":"Whether this 'aggregating subscription' should collect charges (starting now) from all other subscriptions (current and future) belonging to this BillForward Account.","verbs":["POST"]}
	AggregateAllSubscriptionsOnAccount *bool `json:"aggregateAllSubscriptionsOnAccount,omitempty"`

	// {"default":"(empty list)","description":"[Required if and only if `productRatePlan` is omitted] List of components whose prices should be recalculated upon invoice aggregation. For example: two subscriptions' individual consumptions may neither of them be large enough to achieve bulk buy discounts. When aggregated, though, the same two subscriptions' consumption may add up to a quantity which does merit a bulk buy discount within your tiering system.","verbs":["POST"]}
	AggregatingComponents []*CreateAggregatingComponentRequest `json:"aggregatingComponents"`

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`

	// {"description":"[Required if and only if `productRatePlan` is omitted] The currency of the product-rate-plan &mdash; as specified by a three-character ISO 4217 currency code (i.e. USD).","verbs":["POST"]}
	// Required: true
	Currency *string `json:"currency"`

	// {"default":"(null)","description":"Description of the created subscription. This is primarily for your benefit &mdash; for example, you could write here the mechanism through which you obtained this customer. (e.g. 'Business signed up using BUSYGUYS coupon, at management trade show').","verbs":["POST"]}
	Description string `json:"description,omitempty"`

	// {"description":"[Required if and only if `productRatePlan` is omitted] Number of length-measures which constitute the rate plan's period.","verbs":["POST"]}
	Duration int32 `json:"duration,omitempty"`

	// {"description":"[Required if and only if `productRatePlan` is omitted] Measure describing the magnitude of the rate plan's period.","verbs":["POST"]}
	DurationPeriod string `json:"durationPeriod,omitempty"`

	// {"default":"(Subscription will be named after the rate plan to which the subscription subscribes)","description":"Name of the created subscription. This is primarily for your benefit &mdash; for example, to enable you to identify subscriptions at a glance in the BillForward web interface (e.g. 'BusinessCorp subscriptions, care of Mr Business (mr@busy.com)').","verbs":["POST"]}
	Name string `json:"name,omitempty"`

	// {"default":"(Auto-populated using your authentication credentials)","description":"ID of the BillForward Organization within which the requested Subscription should be created. If omitted, this will be auto-populated using your authentication credentials.","verbs":["POST"]}
	OrganizationID string `json:"organizationID,omitempty"`

	// {"description":"ID of the rate plan to which the subscription will be subscribing. If omitted: it will be assumed you wish to create a new rate plan as part of this request &mdash; this subscription will subscribe to that newly-created rate plan.","verbs":["POST"]}
	ProductRatePlan string `json:"productRatePlan,omitempty"`

	// {"description":"[Required if and only if `productRatePlan` is omitted] The frequency of the rate plan &mdash; either recurring or non-recurring.","verbs":["POST"]}
	ProductType string `json:"productType,omitempty"`

	// {"default":"(ServerNow upon receiving request)","description":"ISO 8601 UTC DateTime (e.g. 2015-06-16T11:58:41Z) describing the date at which the subscription should enter its first service period.","verbs":["POST"]}
	Start strfmt.DateTime `json:"start,omitempty"`

	// {"default":"Provisioned","description":"The state in which the created subscription will begin.<br><span class=\"label label-default\">Provisioned</span> &mdash; The subscription will wait (without raising any invoices or beginning its service) until explicit action is taken to change its state.<br><span class=\"label label-default\">AwaitingPayment</span> &mdash; The subscription is activated. After `start` time is surpassed, it will begin service and raise its first invoice.","verbs":["POST"]}
	State string `json:"state,omitempty"`
}

CreateAggregatingSubscriptionRequest Entity for requesting that an 'aggregating subscription' (i.e. a 'parent subscription' which collects the charges raised by many 'child subscriptions') be created. swagger:model CreateAggregatingSubscriptionRequest

func (*CreateAggregatingSubscriptionRequest) Validate 

func (m *CreateAggregatingSubscriptionRequest) Validate(formats strfmt.Registry) error

Validate validates this create aggregating subscription request

type CreateProfileAddressRequest 

type CreateProfileAddressRequest struct {

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	// Required: true
	AddressLine1 *string `json:"addressLine1"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	AddressLine2 string `json:"addressLine2,omitempty"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	AddressLine3 string `json:"addressLine3,omitempty"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	// Required: true
	City *string `json:"city"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	// Required: true
	Country *string `json:"country"`

	// { "description" : "Phone number", "verbs":["POST","PUT","GET"] }
	Landline string `json:"landline,omitempty"`

	// { "description" : "ZIP code or postcode.", "verbs":["POST","PUT","GET"] }
	// Required: true
	Postcode *string `json:"postcode"`

	// { "description" : "Is this the primary, default, address for the associated profile?", "verbs":["POST","PUT","GET"] }
	PrimaryAddress *bool `json:"primaryAddress,omitempty"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	// Required: true
	Province *string `json:"province"`
}

CreateProfileAddressRequest create profile address request swagger:model CreateProfileAddressRequest

func (*CreateProfileAddressRequest) Validate 

func (m *CreateProfileAddressRequest) Validate(formats strfmt.Registry) error

Validate validates this create profile address request

type CreateSubscriptionBatchRequest 

type CreateSubscriptionBatchRequest struct {

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`

	// {"default":"(Auto-populated using your authentication credentials)","description":"ID of the BillForward Organization within which the requested Subscriptions should be created. If omitted, this will be auto-populated using your authentication credentials.","verbs":["POST"]}
	OrganizationID string `json:"organizationID,omitempty"`

	// {"default":"(Empty list)","description":"List of entities for requesting that subscriptions be created.","verbs":["POST"]}
	Subscriptions []*CreateSubscriptionRequest `json:"subscriptions"`
}

CreateSubscriptionBatchRequest Entity for requesting that a batch of subscriptions be created. swagger:model CreateSubscriptionBatchRequest

func (*CreateSubscriptionBatchRequest) Validate 

func (m *CreateSubscriptionBatchRequest) Validate(formats strfmt.Registry) error

Validate validates this create subscription batch request

type CreateSubscriptionRequest 

type CreateSubscriptionRequest struct {

	// {"description":"ID of the BillForward Account who will own this subscription. You should ensure beforehand that the customer has had a BillForward Account created for them.","verbs":["POST"]}
	// Required: true
	AccountID *string `json:"accountID"`

	// {"default":false,"description":"Whether this subscription should become an 'aggregating subscription', collecting charges (starting now) from all other subscriptions (current and future) belonging to this BillForward Account.","verbs":["POST"]}
	AggregateAllSubscriptionsOnAccount *bool `json:"aggregateAllSubscriptionsOnAccount,omitempty"`

	// {"default":true,"description":"Whether to override the `end` date to line up with the current period end of the 'aggregating subscription' to which this subscription belongs.","verbs":["POST"]}
	AlignPeriodWithAggregatingSubscription *bool `json:"alignPeriodWithAggregatingSubscription,omitempty"`

	// {"description":"start of the contracted period.  This will be after a trial, if one exists","verbs":["GET"]}
	ContractStart strfmt.DateTime `json:"contractStart,omitempty"`

	// {"default":"(null)","description":"Description of the created subscription. This is primarily for your benefit &mdash; for example, you could write here the mechanism through which you obtained this customer. (e.g. 'Customer obtained through Lazy Wednesdays promotion').","verbs":["POST"]}
	Description string `json:"description,omitempty"`

	// {"default":"(1 period ahead of the `start` time)","description":"ISO 8601 UTC DateTime (e.g. 2015-06-16T11:58:41Z) describing the date at which the subscription should finish its first service period.","verbs":["POST"]}
	End *strfmt.DateTime `json:"end,omitempty"`

	// {"default":"None","description":"The action that should be taken, should an invoice for some subscription to this rate plan remain unpaid despite the dunning period's being exceeded.<br><span class=\"label label-default\">CancelSubscription</span> &mdash; Demotes the subscription to the `Failed` state as soon as the dunning period is exceeded.<br><span class=\"label label-default\">None</span> &mdash; The subscription is allowed to continue in the `AwaitingPayment` state indefinitely even if the dunning period is exceeded.For slow payment cycles &mdash; or when manual invoice remediation is common &mdash; <span class=\"label label-default\">None</span> is recommended.<br>In a heavily-automated SaaS environment, automatic cancellation via <span class=\"label label-default\">CancelSubscription</span> is recommended.","verbs":["POST","PUT","GET"]}
	FailedPaymentBehaviour string `json:"failedPaymentBehaviour,omitempty"`

	// { "description" : "Add metadata.", "verbs":["POST"] }
	Metadata DynamicMetadata `json:"metadata,omitempty"`

	// {"default":"(Subscription will be named after the rate plan to which the subscription subscribes)","description":"Name of the created subscription. This is primarily for your benefit &mdash; for example, to enable you to identify subscriptions at a glance in the BillForward web interface (e.g. 'Customer 1425, guy@mail.com, Premium membership').","verbs":["POST"]}
	Name string `json:"name,omitempty"`

	// {"default":"(Auto-populated using your authentication credentials)","description":"ID of the BillForward Organization within which the requested Subscription should be created. If omitted, this will be auto-populated using your authentication credentials.","verbs":["POST"]}
	OrganizationID string `json:"organizationID,omitempty"`

	// {"default":"(If a subscription exists which 'aggregates all subscriptions belonging to this BillForward Account', refer to the ID of that subscription. Otherwise: null)","description":"ID of a parent subscription which will collect the charges raised by this subscription. The parent becomes responsible for paying those charges. If a subscription exists which 'aggregates all subscriptions belonging to this BillForward Account', then that parent will override any parent specified here.","verbs":["POST"]}
	ParentID string `json:"parentID,omitempty"`

	// payment terms
	PaymentTerms int64 `json:"paymentTerms,omitempty"`

	// {"default":"(empty list)","description":"Quantities that this subscription possesses (upon beginning service), of pricing components upon the subscription's rate plan. For example: you can set the subscription to begin its service with '5 widgets' consumed. Otherwise the 'default quantity' will be observed instead, for each pricing component upon the rate plan.","verbs":["POST"]}
	PricingComponentQuantities []*PricingComponentQuantityRequest `json:"pricingComponentQuantities"`

	// {"description":"Name or ID of the product.","verbs":["POST"]}
	// Required: true
	Product *string `json:"product"`

	// {"description":"ID or name of the rate plan to which the subscription will be subscribing. Lookup by name is only possible if a `productID` is specified.","verbs":["POST"]}
	// Required: true
	ProductRatePlan *string `json:"productRatePlan"`

	// {"default":"(ServerNow upon receiving request)","description":"ISO 8601 UTC DateTime (e.g. 2015-06-16T11:58:41Z) describing the date at which the subscription should enter its first service period.","verbs":["POST"]}
	Start *strfmt.DateTime `json:"start,omitempty"`

	// {"default":"Provisioned","description":"The state in which the created subscription will begin.<br><span class=\"label label-default\">Provisioned</span> &mdash; The subscription will wait (without raising any invoices or beginning its service) until explicit action is taken to change its state.<br><span class=\"label label-default\">AwaitingPayment</span> &mdash; The subscription is activated. After `start` time is surpassed, it will begin service and raise its first invoice.","verbs":["POST"]}
	State string `json:"state,omitempty"`

	// {"default":"(null)","description":"ISO 8601 UTC DateTime (e.g. 2015-06-16T11:58:41Z) describing the date at which the subscription should leave the trial period.","verbs":["POST"]}
	TrialEnd *strfmt.DateTime `json:"trialEnd,omitempty"`

	// type
	Type string `json:"type,omitempty"`
}

CreateSubscriptionRequest Entity for requesting that a subscription be created. swagger:model CreateSubscriptionRequest

func (*CreateSubscriptionRequest) Validate 

func (m *CreateSubscriptionRequest) Validate(formats strfmt.Registry) error

Validate validates this create subscription request

type CreateWebhookRequest 

type CreateWebhookRequest struct {

	// url
	URL string `json:"url,omitempty"`
}

CreateWebhookRequest create webhook request swagger:model CreateWebhookRequest

func (*CreateWebhookRequest) Validate 

func (m *CreateWebhookRequest) Validate(formats strfmt.Registry) error

Validate validates this create webhook request

type CreditNote 

type CreditNote struct {

	// { "description" : "", "verbs":["POST","GET"] }
	// Required: true
	AccountID *string `json:"accountID"`

	// { "description" : "ID of the user who last updated the entity.", "verbs":[] }
	ChangedBy string `json:"changedBy,omitempty"`

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`

	// { "description" : "", "verbs":["GET"] }
	CreatedBy string `json:"createdBy,omitempty"`

	// { "description" : "Currency of the credit-note specified by a three character ISO 4217 currency code.", "verbs":["POST","GET"] }
	// Required: true
	Currency *string `json:"currency"`

	// { "description" : "", "verbs":["POST","GET"] }
	Description string `json:"description,omitempty"`

	// { "description" : "", "verbs":["GET"] }
	ID string `json:"id,omitempty"`

	// { "description" : "References an invoice from this credit note. This has no side-effects, such as limited scope of credit note.", "verbs":["POST","GET"] }
	InvoiceID string `json:"invoiceID,omitempty"`

	// { "description" : "", "verbs":[] }
	OrganizationID string `json:"organizationID,omitempty"`

	// { "description" : "Remaining value of the payment not used. In the case when a credit-note is used across a range of invoices, each use reducing the available blance of the credit note.", "verbs":["GET"] }
	// Required: true
	RemainingValue *float64 `json:"remainingValue"`

	// { "description" : "Subscription to apply the credit note to. By default credit notes are owned by the account an can be used on any subscription. Providing this value limits the credit-note to only being used on the specified subscription.", "verbs":["POST","GET"] }
	SubscriptionID string `json:"subscriptionID,omitempty"`

	// { "description" : "", "verbs":[] }
	// Required: true
	Type *string `json:"type"`

	// { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }
	Updated strfmt.DateTime `json:"updated,omitempty"`

	// { "description" : " Monetary value of the credit-note", "verbs":["POST","GET"] }
	// Required: true
	Value *float64 `json:"value"`
}

CreditNote CreditNote swagger:model CreditNote

func (*CreditNote) Validate 

func (m *CreditNote) Validate(formats strfmt.Registry) error

Validate validates this credit note

type DunningLine 

type DunningLine struct {

	// { "description" : "The payment attempt this dunning line applies to, specified as a positive integer. Dunning lines are ZERO indexed.", "verbs":["POST","PUT","GET"] }
	// Required: true
	AttemptIx *int32 `json:"attemptIx"`

	// { "description" : "ID of the user who last updated the entity.", "verbs":[] }
	ChangedBy string `json:"changedBy,omitempty"`

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`

	// { "description" : "Has the dunning-line been deleted?", "verbs":["POST","PUT","GET"] }
	// Required: true
	Deleted bool `json:"deleted"`

	// { "description" : "The payment gateway to use for this payment attempt.", "verbs":["POST","PUT","GET"] }
	// Required: true
	Gateway *string `json:"gateway"`

	// { "description" : "ID of the dunning-line.", "verbs":["GET"] }
	ID string `json:"id,omitempty"`

	// { "description" : "The time before the next payment attempt in minutes.", "verbs":["POST","PUT","GET"] }
	// Required: true
	MinutesDelay *int32 `json:"minutesDelay"`

	// { "description" : "organization associated with the dunning-line.", "verbs":["POST","PUT","GET"] }
	// Required: true
	Organization *Organization `json:"organization"`

	// { "description" : "ID of the organization associated with the dunning-line.", "verbs":["POST","PUT","GET"] }
	// Required: true
	OrganizationID *string `json:"organizationID"`

	// { "description" : "ID of the organization associated with the dunning-line.", "verbs":["POST","PUT","GET"] }
	// Required: true
	Type *string `json:"type"`

	// { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }
	Updated strfmt.DateTime `json:"updated,omitempty"`
}

DunningLine A dunning-line specifies when the next execution attempt of an unpaid invoice should take place given the number of existing execution attempts. swagger:model DunningLine

func (*DunningLine) Validate 

func (m *DunningLine) Validate(formats strfmt.Registry) error

Validate validates this dunning line

type DynamicMetadata 

type DynamicMetadata map[string]interface{}

DynamicMetadata dynamic metadata swagger:model DynamicMetadata

func (DynamicMetadata) Validate 

func (m DynamicMetadata) Validate(formats strfmt.Registry) error

Validate validates this dynamic metadata

type ExecuteInvoiceRequest 

type ExecuteInvoiceRequest struct {

	// force paid
	// Required: true
	ForcePaid bool `json:"forcePaid"`
}

ExecuteInvoiceRequest execute invoice request swagger:model ExecuteInvoiceRequest

func (*ExecuteInvoiceRequest) Validate 

func (m *ExecuteInvoiceRequest) Validate(formats strfmt.Registry) error

Validate validates this execute invoice request

type FixedTerm 

type FixedTerm struct {

	// { "description" : "ID of the user who last updated the entity.", "verbs":[] }
	ChangedBy string `json:"changedBy,omitempty"`

	// { "description" : "compoundUplift", "verbs":["POST","PUT","GET"] }The proportional INCREASE in price applied every time the fixed terms recur. e.g. 0.03 is a 3% increase. -0.5 is a 50% decrease. 3 is a 300% increase
	// Required: true
	CompoundUplift *float64 `json:"compoundUplift"`

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`

	// { "description" : "Is the fixedTerm deleted.", "verbs":["POST","PUT","GET"] }
	// Required: true
	Deleted bool `json:"deleted"`

	// fixedTermExpiryBehaviour
	// Required: true
	ExpiryBehaviour *string `json:"expiryBehaviour"`

	// expiry_time
	// Required: true
	ExpiryTime *strfmt.DateTime `json:"expiryTime"`

	// fixed term definition
	// Required: true
	FixedTermDefinition *MutableBillingEntity `json:"fixedTermDefinition"`

	// { "description" : "fixedTermDefinitionID", "verbs":["POST","PUT","GET"] }
	// Required: true
	FixedTermDefinitionID *string `json:"fixedTermDefinitionID"`

	// { "description" : "The number of sequential fixed terms previous to this one for the subscription (i.e. zero indexed 'fixedTermCount').", "verbs":["POST","PUT","GET"] }
	// Required: true
	FixedTermNumber *int32 `json:"fixedTermNumber"`

	// id
	ID string `json:"id,omitempty"`

	// { "description" : "The ID of the organization associated with the amendment.", "verbs":["POST","PUT","GET"] }
	// Required: true
	OrganizationID *string `json:"organizationID"`

	// { "description" : "The number of billing periods that this fixed term lasts for.", "verbs":["POST","PUT","GET"] }
	// Required: true
	Periods *int32 `json:"periods"`

	// productRatePlanAsOfTime
	// Required: true
	ProductRatePlanAsOfTime *strfmt.DateTime `json:"productRatePlanAsOfTime"`

	// start_time
	// Required: true
	StartTime *strfmt.DateTime `json:"startTime"`

	// state
	// Required: true
	State *string `json:"state"`

	// { "description" : "subscriptionID", "verbs":["POST","PUT","GET"] }
	// Required: true
	SubscriptionID *string `json:"subscriptionID"`

	// { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }
	Updated strfmt.DateTime `json:"updated,omitempty"`
}

FixedTerm FixedTerm swagger:model FixedTerm

func (*FixedTerm) Validate 

func (m *FixedTerm) Validate(formats strfmt.Registry) error

Validate validates this fixed term

type FlatPricingComponent 

type FlatPricingComponent struct {
	// contains filtered or unexported fields
}

FlatPricingComponent flat pricing component swagger:model flatPricingComponent

func (*FlatPricingComponent) AtType 

func (m *FlatPricingComponent) AtType() string

func (*FlatPricingComponent) ChangedBy 

func (m *FlatPricingComponent) ChangedBy() string

func (*FlatPricingComponent) ChargeModel 

func (m *FlatPricingComponent) ChargeModel() *string

func (*FlatPricingComponent) ChargeType 

func (m *FlatPricingComponent) ChargeType() *string

func (*FlatPricingComponent) Created 

func (m *FlatPricingComponent) Created() strfmt.DateTime

func (*FlatPricingComponent) CrmID 

func (m *FlatPricingComponent) CrmID() string

func (*FlatPricingComponent) DefaultQuantity 

func (m *FlatPricingComponent) DefaultQuantity() *int32

func (*FlatPricingComponent) Description 

func (m *FlatPricingComponent) Description() string

func (*FlatPricingComponent) DowngradeMode 

func (m *FlatPricingComponent) DowngradeMode() string

func (*FlatPricingComponent) ID 

func (m *FlatPricingComponent) ID() *string

func (*FlatPricingComponent) InvoicingType 

func (m *FlatPricingComponent) InvoicingType() string

func (FlatPricingComponent) MarshalJSON 

func (m FlatPricingComponent) MarshalJSON() ([]byte, error)

MarshalJSON marshals this polymorphic type to a JSON structure

func (*FlatPricingComponent) MaxQuantity 

func (m *FlatPricingComponent) MaxQuantity() int32

func (*FlatPricingComponent) MinQuantity 

func (m *FlatPricingComponent) MinQuantity() int32

func (*FlatPricingComponent) Name 

func (m *FlatPricingComponent) Name() *string

func (*FlatPricingComponent) OrganizationID 

func (m *FlatPricingComponent) OrganizationID() *string

func (*FlatPricingComponent) ProductRatePlanID 

func (m *FlatPricingComponent) ProductRatePlanID() *string

func (*FlatPricingComponent) PublicName 

func (m *FlatPricingComponent) PublicName() string

func (*FlatPricingComponent) SetAtType 

func (m *FlatPricingComponent) SetAtType(val string)

func (*FlatPricingComponent) SetChangedBy 

func (m *FlatPricingComponent) SetChangedBy(val string)

func (*FlatPricingComponent) SetChargeModel 

func (m *FlatPricingComponent) SetChargeModel(val *string)

func (*FlatPricingComponent) SetChargeType 

func (m *FlatPricingComponent) SetChargeType(val *string)

func (*FlatPricingComponent) SetCreated 

func (m *FlatPricingComponent) SetCreated(val strfmt.DateTime)

func (*FlatPricingComponent) SetCrmID 

func (m *FlatPricingComponent) SetCrmID(val string)

func (*FlatPricingComponent) SetDefaultQuantity 

func (m *FlatPricingComponent) SetDefaultQuantity(val *int32)

func (*FlatPricingComponent) SetDescription 

func (m *FlatPricingComponent) SetDescription(val string)

func (*FlatPricingComponent) SetDowngradeMode 

func (m *FlatPricingComponent) SetDowngradeMode(val string)

func (*FlatPricingComponent) SetID 

func (m *FlatPricingComponent) SetID(val *string)

func (*FlatPricingComponent) SetInvoicingType 

func (m *FlatPricingComponent) SetInvoicingType(val string)

func (*FlatPricingComponent) SetMaxQuantity 

func (m *FlatPricingComponent) SetMaxQuantity(val int32)

func (*FlatPricingComponent) SetMinQuantity 

func (m *FlatPricingComponent) SetMinQuantity(val int32)

func (*FlatPricingComponent) SetName 

func (m *FlatPricingComponent) SetName(val *string)

func (*FlatPricingComponent) SetOrganizationID 

func (m *FlatPricingComponent) SetOrganizationID(val *string)

func (*FlatPricingComponent) SetProductRatePlanID 

func (m *FlatPricingComponent) SetProductRatePlanID(val *string)

func (*FlatPricingComponent) SetPublicName 

func (m *FlatPricingComponent) SetPublicName(val string)

func (*FlatPricingComponent) SetTiers 

func (m *FlatPricingComponent) SetTiers(val []*PricingComponentTier)

func (*FlatPricingComponent) SetUnitOfMeasure 

func (m *FlatPricingComponent) SetUnitOfMeasure(val *UnitOfMeasure)

func (*FlatPricingComponent) SetUnitOfMeasureID 

func (m *FlatPricingComponent) SetUnitOfMeasureID(val *string)

func (*FlatPricingComponent) SetUpdated 

func (m *FlatPricingComponent) SetUpdated(val strfmt.DateTime)

func (*FlatPricingComponent) SetUpgradeMode 

func (m *FlatPricingComponent) SetUpgradeMode(val string)

func (*FlatPricingComponent) SetValidFrom 

func (m *FlatPricingComponent) SetValidFrom(val *strfmt.DateTime)

func (*FlatPricingComponent) SetValidTill 

func (m *FlatPricingComponent) SetValidTill(val *strfmt.DateTime)

func (*FlatPricingComponent) SetVersionID 

func (m *FlatPricingComponent) SetVersionID(val *string)

func (*FlatPricingComponent) Tiers 

func (m *FlatPricingComponent) Tiers() []*PricingComponentTier

func (*FlatPricingComponent) UnitOfMeasure 

func (m *FlatPricingComponent) UnitOfMeasure() *UnitOfMeasure

func (*FlatPricingComponent) UnitOfMeasureID 

func (m *FlatPricingComponent) UnitOfMeasureID() *string

func (*FlatPricingComponent) UnmarshalJSON 

func (m *FlatPricingComponent) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this polymorphic type from a JSON structure

func (*FlatPricingComponent) Updated 

func (m *FlatPricingComponent) Updated() strfmt.DateTime

func (*FlatPricingComponent) UpgradeMode 

func (m *FlatPricingComponent) UpgradeMode() string

func (*FlatPricingComponent) ValidFrom 

func (m *FlatPricingComponent) ValidFrom() *strfmt.DateTime

func (*FlatPricingComponent) ValidTill 

func (m *FlatPricingComponent) ValidTill() *strfmt.DateTime

func (*FlatPricingComponent) Validate 

func (m *FlatPricingComponent) Validate(formats strfmt.Registry) error

Validate validates this flat pricing component

func (*FlatPricingComponent) VersionID 

func (m *FlatPricingComponent) VersionID() *string

type InsertableBillingEntity 

type InsertableBillingEntity struct {

	// { "description" : "The UTC DateTime when the pricing-component-value-change was processed.", "verbs":["POST","PUT","GET"] }
	Applied strfmt.DateTime `json:"applied,omitempty"`

	// { "description" : "The UTC DateTime when the pricing-component-value-change was calculated.", "verbs":["POST","PUT","GET"] }
	// Required: true
	AsOf *strfmt.DateTime `json:"asOf"`

	// { "description" : "ID of the user who last updated the entity.", "verbs":[] }
	ChangedBy string `json:"changedBy,omitempty"`

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`

	// { "description" : "ID of the pricing-component-value-change.", "verbs":["POST","PUT","GET"] }
	ID string `json:"id,omitempty"`

	// { "description" : "ID of the invoice associated with the pricing-component-value-change.", "verbs":["POST","PUT","GET"] }
	// Required: true
	InvoiceID *string `json:"invoiceID"`

	// { "description" : "The value change mode.", "verbs":["POST","PUT","GET"] }
	// Required: true
	Mode *string `json:"mode"`

	// { "description" : "The new value of the pricing-component.", "verbs":["POST","PUT","GET"] }
	// Required: true
	NewValue *int32 `json:"newValue"`

	// { "description" : "The new value of the pricing-component.", "verbs":["POST","PUT","GET"] }
	// Required: true
	OldValue *int32 `json:"oldValue"`

	// { "description" : "The organizationID.", "verbs":["POST","PUT","GET"] }
	// Required: true
	OrganizationID *string `json:"organizationID"`

	// { "description" : "ID of the pricing-component associated with the pricing-component-value-change.", "verbs":["POST","PUT","GET"] }
	// Required: true
	PricingComponentID *string `json:"pricingComponentID"`

	// { "description" : "The value change state.", "verbs":["POST","PUT","GET"] }
	// Required: true
	State *string `json:"state"`

	// { "description" : "ID of the subscription associated with the pricing-component-value-change.", "verbs":["POST","PUT","GET"] }
	// Required: true
	SubscriptionID *string `json:"subscriptionID"`

	// { "description" : "ID of the unit-of-measure associated with the pricing-component-value-change.", "verbs":["POST","PUT","GET"] }
	UnitOfMeasureID string `json:"unitOfMeasureID,omitempty"`
}

InsertableBillingEntity Insertable entities are those entities that can be created. swagger:model InsertableBillingEntity

func (*InsertableBillingEntity) Validate 

func (m *InsertableBillingEntity) Validate(formats strfmt.Registry) error

Validate validates this insertable billing entity

type Invoice 

type Invoice struct {

	// { "description" : "", "verbs":["GET"] }
	// Required: true
	AccountID *string `json:"accountID"`

	// { "description" : "ID of the user who last updated the entity.", "verbs":[] }
	ChangedBy string `json:"changedBy,omitempty"`

	// charges
	Charges []*SubscriptionCharge `json:"charges"`

	// children
	Children []*Invoice `json:"children"`

	// { "description" : "Cost of the invoice exclusive of tax.", "verbs":["GET"] }
	// Required: true
	CostExcludingTax *float64 `json:"costExcludingTax"`

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`

	// { "description" : "The amount of credit to be returned to the pool.", "verbs":["GET"] }
	// Required: true
	CreditRolledOver *float64 `json:"creditRolledOver"`

	// { "description" : "The amount of credit to be returned to the pool excluding tax.", "verbs":["GET"] }
	CreditRolledOverExcludingTax float64 `json:"creditRolledOverExcludingTax,omitempty"`

	// { "description" : "CRM identifier of the invoice.", "verbs":["PUT","GET"] }
	CrmID string `json:"crmID,omitempty"`

	// { "description" : "Currency of the invoice specified by a three character ISO 4217 currency code.", "verbs":["GET"] }
	// Required: true
	Currency *string `json:"currency"`

	// { "description" : "Indicates if an invoice has been retired. If an invoice has been retired it can still be retrieved using the appropriate flag on API requests. Generally invoices will not be retired.", "verbs":[] }
	// Required: true
	Deleted bool `json:"deleted"`

	// { "description" : "The description of the invoice", "verbs":[] }
	Description string `json:"description,omitempty"`

	// { "description" : "The amount of discounts for the invoice.", "verbs":["GET"] }
	DiscountAmount float64 `json:"discountAmount,omitempty"`

	// { "description" : "The amount of discounts for the invoice excluding tax.", "verbs":["GET"] }
	DiscountAmountExcludingTax float64 `json:"discountAmountExcludingTax,omitempty"`

	// { "description" : "Date this invoice is due, UTC DateTime.", "verbs":["GET"] }
	Due strfmt.DateTime `json:"due,omitempty"`

	// { "description" : "UTC DateTime of the invoice's final execution attempt. The final execution attempt. This may be less than the next execution attempt if the next execution attempt never occurred.", "verbs":["GET"] }
	FinalExecutionAttempt strfmt.DateTime `json:"finalExecutionAttempt,omitempty"`

	// { "description" : "Unique identifier for the invoice.", "verbs":["GET"] }
	ID string `json:"id,omitempty"`

	// { "description" : "Is this an initial invoice. An initial invoice is the first invoice generated for a subscription. Initial invoices will not have dunning applied to them and as such will only have a single payment attempt. For trial periods, the trial invoice is the initial invoice.", "verbs":["GET"] }
	// Required: true
	InitialInvoice bool `json:"initialInvoice"`

	// { "description" : "Cost of the invoice inclusive of tax.", "verbs":["GET"] }
	// Required: true
	InvoiceCost *float64 `json:"invoiceCost"`

	// { "description" : "Credit Notes associated with this invoice. Multiple credit notes may be associated with the invoice.", "verbs":["GET"] }
	InvoiceCreditNotes []*CreditNote `json:"invoiceCreditNotes"`

	// { "description" : "The collection of invoice-lines associated with the invoice.", "verbs":["GET"] }
	InvoiceLines []*InvoiceLine `json:"invoiceLines"`

	// { "description" : "Total amount of the invoice currently paid for. As the invoice may be paid by multiple payments, for example partly paid for by a voucher and then paid for by a card, this indicates the current paid amount of the invoice.", "verbs":["GET"] }
	InvoicePaid float64 `json:"invoicePaid,omitempty"`

	// { "description" : "Payments used for this invoice. Multiple payments may be associated with the invoice.", "verbs":["GET"] }
	InvoicePayments []*InvoicePayment `json:"invoicePayments"`

	// { "description" : "Total amount of the invoice refunded.", "verbs":["GET"] }
	InvoiceRefunded float64 `json:"invoiceRefunded,omitempty"`

	// { "description" : "Refunds associated with this invoice. Multiple refunds may be associated with the invoice.", "verbs":["GET"] }
	InvoiceRefunds []*Refund `json:"invoiceRefunds"`

	// { "description" : "The UTC DateTime when the invoice was first issued.", "verbs":["GET"] }
	Issued strfmt.DateTime `json:"issued,omitempty"`

	// { "description" : "UTC DateTime of the invoice's last execution attempt. This was the last time an attempt was made to take payment for this invoice.", "verbs":["GET"] }
	LastExecutionAttempt strfmt.DateTime `json:"lastExecutionAttempt,omitempty"`

	// { "description" : "If the subscription is locked, it will not be processed by the system", "verbs":[] }
	Locked string `json:"locked,omitempty"`

	// { "description" : "Which system is responsible for managing the subscription.", "verbs":[] }
	ManagedBy string `json:"managedBy,omitempty"`

	// { "description" : "The name of the invoice", "verbs":[] }
	Name string `json:"name,omitempty"`

	// { "description" : "UTC DateTime of the invoice's next execution attempt. If the next execution attempt is greater than the period end for this invoice, the invoice will not receive another automatic execution attempt.", "verbs":["GET"] }
	NextExecutionAttempt strfmt.DateTime `json:"nextExecutionAttempt,omitempty"`

	// Cost of the invoice before discounts, inclusive of tax.
	// Required: true
	NonDiscountedCost *float64 `json:"nonDiscountedCost"`

	// Cost of the invoice before discounts, inclusive of tax.
	// Required: true
	NonDiscountedCostExcludingTax *float64 `json:"nonDiscountedCostExcludingTax"`

	// { "description" : "", "verbs":[] }
	// Required: true
	OrganizationID *string `json:"organizationID"`

	// { "description" : "", "verbs":[] }
	ParentInvoiceID string `json:"parentInvoiceID,omitempty"`

	// { "description" : "UTC DateTime specifying when payment was received for the invoice.", "verbs":["GET"] }
	PaymentReceived strfmt.DateTime `json:"paymentReceived,omitempty"`

	// { "description" : "End of the period being billed by this invoice, UTC DateTime.", "verbs":["GET"] }
	PeriodEnd strfmt.DateTime `json:"periodEnd,omitempty"`

	// { "description" : "Start of the period being billed by this invoice, UTC DateTime", "verbs":["GET"] }
	PeriodStart strfmt.DateTime `json:"periodStart,omitempty"`

	// { "description" : "Initially an invoice is set as unpaid. Once payment for the full value of the invoice has been received it is marked as paid. An invoice may be paid from various sources including cards, coupons or manual payments.", "verbs":["GET"] }
	// Required: true
	State *string `json:"state"`

	// { "description" : "", "verbs":["GET"] }
	SubscriptionID string `json:"subscriptionID,omitempty"`

	// { "description" : "", "verbs":["GET"] }
	// Required: true
	SubscriptionVersionID *string `json:"subscriptionVersionID"`

	// tax lines
	TaxLines []*InsertableBillingEntity `json:"taxLines"`

	// { "description" : "Number of payment attempts for this invoice. This includes any manual execution attempts.", "verbs":["GET"] }
	TotalExecutionAttempts int32 `json:"totalExecutionAttempts,omitempty"`

	// { "description" : "The type of the invoice. A subscription invoice is raised every time a subscription recurs. An amendment is created for intra-contract changes. An Adhoc invoice is created for payment that is taken out-of-band of a subscription. Finally the invoice generated for a trial period is marked as Trial.", "verbs":["GET"] }
	// Required: true
	Type *string `json:"type"`

	// { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }
	Updated strfmt.DateTime `json:"updated,omitempty"`

	// { "description" : "Version identifier of the invoice.", "verbs":["GET"] }
	VersionID string `json:"versionID,omitempty"`

	// { "description" : "The version number of the Invoice.  The first version of an Invoice is version number 1", "verbs":["GET"] }
	// Required: true
	VersionNumber *int32 `json:"versionNumber"`
}

Invoice An invoice encapsulates the cumulative charges of a subscription's pricing-components and their respective pricing-component-values for a specific period of time. swagger:model Invoice

func (*Invoice) Validate 

func (m *Invoice) Validate(formats strfmt.Registry) error

Validate validates this invoice

type InvoiceLine 

type InvoiceLine struct {

	// { "description" : "A human readable explanation of how the value of the invoice-line was calculated.", "verbs":["POST","PUT","GET"] }
	// Required: true
	Calculation *string `json:"calculation"`

	// { "description" : "ID of the user who last updated the entity.", "verbs":[] }
	ChangedBy string `json:"changedBy,omitempty"`

	// { "description" : "charge-type.", "verbs":["POST","PUT","GET"] }
	// Required: true
	ChargeType *string `json:"chargeType"`

	// The ID of the invoice that is associated with the invoice-line.
	// Required: true
	ChildInvoiceID *string `json:"childInvoiceID"`

	// { "description" : "The component value for the unit-of-measure that is associated with the invoice-line.", "verbs":["POST","PUT","GET"] }
	// Required: true
	ComponentValue *int32 `json:"componentValue"`

	// { "description" : "The cost of the invoice-line including tax.", "verbs":["POST","PUT","GET"] }
	// Required: true
	Cost *float64 `json:"cost"`

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`

	// { "description" : "The human readable description of the invoice-line.", "verbs":["POST","PUT","GET"] }
	// Required: true
	Description *string `json:"description"`

	// { "description" : "ID of the invoice-line.", "verbs":["POST","PUT","GET"] }
	ID string `json:"id,omitempty"`

	// { "description" : "invoice associated with the invoice-line.", "verbs":["POST","PUT","GET"] }
	// Required: true
	InvoiceID *string `json:"invoiceID"`

	// { "description" : "The human readable name of the invoice-line.", "verbs":["POST","PUT","GET"] }
	// Required: true
	Name *string `json:"name"`

	// { "description" : "ID of the organization associated with the invoice-line.", "verbs":["POST","PUT","GET"] }
	// Required: true
	OrganizationID *string `json:"organizationID"`

	// The period end of the charge.
	// Required: true
	PeriodEnd *strfmt.DateTime `json:"periodEnd"`

	// The period start of the charge.
	// Required: true
	PeriodStart *strfmt.DateTime `json:"periodStart"`

	// The ID of the pricing-component that is associated with the invoice-line.
	// Required: true
	PricingComponentID *string `json:"pricingComponentID"`

	// The name of the pricing-component that is associated with the invoice-line.
	// Required: true
	PricingComponentName *string `json:"pricingComponentName"`

	// { "description" : "The type of the pricing component associated with the invoice line.", "verbs":["POST","PUT","GET"] }
	// Required: true
	PricingComponentType *string `json:"pricingComponentType"`

	// { "description" : "the product ID associated with the invoice-line.", "verbs":["POST","PUT","GET"] }
	ProductID string `json:"productID,omitempty"`

	// { "description" : "the product name associated with the invoice-line.", "verbs":["POST","PUT","GET"] }
	ProductName string `json:"productName,omitempty"`

	// { "description" : "the product rate plan ID associated with the invoice-line.", "verbs":["POST","PUT","GET"] }
	ProductRatePlanID string `json:"productRatePlanID,omitempty"`

	// { "description" : "the product rate plan name associated with the invoice-line.", "verbs":["POST","PUT","GET"] }
	ProductRatePlanName string `json:"productRatePlanName,omitempty"`

	// The public name of the pricing-component that is associated with the invoice-line.
	// Required: true
	PublicPricingComponentName *string `json:"publicPricingComponentName"`

	// { "description" : "the public product name associated with the invoice-line.", "verbs":["POST","PUT","GET"] }
	PublicProductName string `json:"publicProductName,omitempty"`

	// { "description" : "the public product rate plan name associated with the invoice-line.", "verbs":["POST","PUT","GET"] }
	PublicProductRatePlanName string `json:"publicProductRatePlanName,omitempty"`

	// The ID of the subscription-charge that is associated with the invoice-line.
	// Required: true
	SubscriptionChargeID *string `json:"subscriptionChargeID"`

	// { "description" : "the subscription ID associated with the invoice-line.", "verbs":["POST","PUT","GET"] }
	SubscriptionID string `json:"subscriptionID,omitempty"`

	// { "description" : "The cumulative tax of the invoice-line.", "verbs":["POST","PUT","GET"] }
	// Required: true
	Tax *float64 `json:"tax"`

	// The type of the invoice-line.
	// Required: true
	Type *string `json:"type"`

	// { "description" : "The unit-of-measure associated with the invoice-line.", "verbs":["POST","PUT","GET"] }
	UnitOfMeasure *UnitOfMeasure `json:"unitOfMeasure,omitempty"`

	// { "description" : "unit-of-measure associated with the invoice-line.", "verbs":["POST","PUT","GET"] }
	UnitOfMeasureID string `json:"unitOfMeasureID,omitempty"`

	// { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }
	Updated strfmt.DateTime `json:"updated,omitempty"`
}

InvoiceLine An invoice-line represents the portion of an invoice specific to one particular pricing-component and its associated pricing-component-value. swagger:model InvoiceLine

func (*InvoiceLine) Validate 

func (m *InvoiceLine) Validate(formats strfmt.Registry) error

Validate validates this invoice line

type InvoicePagedMetadata 

type InvoicePagedMetadata struct {

	// {"description":"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.","verbs":["GET","PUT","POST"]}
	// Required: true
	CurrentOffset *int32 `json:"currentOffset"`

	// {"description":"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.","verbs":["GET","PUT","POST"]}
	// Required: true
	CurrentPage *int32 `json:"currentPage"`

	// {"description":"Number of milliseconds taken by API to calculate response.","verbs":["GET","PUT","POST"]}
	// Required: true
	ExecutionTime *int64 `json:"executionTime"`

	// {"description":"Paging parameter. URL fragment that can be used to fetch next page of results.","verbs":["GET","PUT","POST"]}
	// Required: true
	NextPage *string `json:"nextPage"`

	// {"default":10,"description":"Paging parameter. Describes how many records you requested.","verbs":["GET","PUT","POST"]}
	// Required: true
	RecordsRequested *int32 `json:"recordsRequested"`

	// {"description":"Describes how many records were returned by your query.","verbs":["GET","PUT","POST"]}
	// Required: true
	RecordsReturned *int32 `json:"recordsReturned"`

	// {"description":"The results returned by your query.","verbs":["GET","PUT","POST"]}
	// Required: true
	Results []*Invoice `json:"results"`
}

InvoicePagedMetadata invoice paged metadata swagger:model InvoicePagedMetadata

func (*InvoicePagedMetadata) Validate 

func (m *InvoicePagedMetadata) Validate(formats strfmt.Registry) error

Validate validates this invoice paged metadata

type InvoicePayment 

type InvoicePayment struct {

	// { "description" : "The value of the payment used by payment-line.", "verbs":["POST","PUT","GET"] }
	// Required: true
	ActualAmount *float64 `json:"actualAmount"`

	// { "description" : "ID of the user who last updated the entity.", "verbs":[] }
	ChangedBy string `json:"changedBy,omitempty"`

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`

	// { "description" : "CRM ID of the invoice.", "verbs":["POST","PUT","GET"] }
	// Required: true
	CrmID *string `json:"crmID"`

	// { "description" : "The currency of the payment specified by a three character ISO 4217 currency code.", "verbs":["POST","PUT","GET"] }
	// Required: true
	Currency *string `json:"currency"`

	// Payment gateway associated with the payment
	// Required: true
	Gateway *string `json:"gateway"`

	// { "description" : "ID of the payment-line.", "verbs":["POST","PUT","GET"] }
	ID string `json:"id,omitempty"`

	// { "description" : "ID of the invoice associated with the payment-line.", "verbs":["POST","PUT","GET"] }
	// Required: true
	InvoiceID *string `json:"invoiceID"`

	// { "description" : "The value that this payment-line represents.", "verbs":["POST","PUT","GET"] }
	// Required: true
	NominalAmount *float64 `json:"nominalAmount"`

	// { "description" : "ID of the organization associated with the invoice-payment.", "verbs":["POST","PUT","GET"] }
	// Required: true
	OrganizationID *string `json:"organizationID"`

	// { "description" : "ID of the payment used.", "verbs":["POST","PUT","GET"] }
	// Required: true
	PaymentID *string `json:"paymentID"`

	// {"description":"The date when the associated payment was received.","verbs":["POST","PUT","GET"]}
	// Required: true
	PaymentReceived *strfmt.DateTime `json:"paymentReceived"`

	// {"description":"The date when the associated payment was refunded.","verbs":["POST","PUT","GET"]}
	// Required: true
	RefundReceived *strfmt.DateTime `json:"refundReceived"`

	// { "description" : "The refunded amount of the invoice-payment.", "verbs":["POST","PUT","GET"] }
	// Required: true
	RefundedAmount *float64 `json:"refundedAmount"`

	// { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }
	Updated strfmt.DateTime `json:"updated,omitempty"`
}

InvoicePayment An invoice-payment specifies the amount of a particular payment used to pay part or entirety of the outstanding balance of the associated invoice. swagger:model InvoicePayment

func (*InvoicePayment) Validate 

func (m *InvoicePayment) Validate(formats strfmt.Registry) error

Validate validates this invoice payment

type MutableBillingEntity 

type MutableBillingEntity struct {

	// { "description" : "ID of the user who last updated the entity.", "verbs":[] }
	ChangedBy string `json:"changedBy,omitempty"`

	// This is config id which links to this sync job.
	// Required: true
	ConfigID *string `json:"configID"`

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`

	// The account who created the synch job.
	CreatedBy string `json:"createdBy,omitempty"`

	// UTC DateTime of the start of the data to sync.
	DataFrom strfmt.DateTime `json:"dataFrom,omitempty"`

	// UTC DateTime of the start of the data to sync.
	DataTill strfmt.DateTime `json:"dataTill,omitempty"`

	// Is the sync job deleted.
	// Required: true
	Deleted bool `json:"deleted"`

	// Description of the Job.
	// Required: true
	Description *string `json:"description"`

	// ID of the Synchronization Job.
	ID string `json:"id,omitempty"`

	// The max number of times the records will try to resync.
	// Required: true
	MaxRetryTimes *int32 `json:"maxRetryTimes"`

	// Name of the Job.
	// Required: true
	Name *string `json:"name"`

	// Organization associated with the refund.
	// Required: true
	OrganizationID *string `json:"organizationID"`

	// The number of times the records tried to resync.
	// Required: true
	RetryAttempted *int32 `json:"retryAttempted"`

	// The scope of the data synch'd.
	// Required: true
	Scope *string `json:"scope"`

	// UTC DateTime of the end of the data to sync.
	Started strfmt.DateTime `json:"started,omitempty"`

	// This is the state of job. Pending jobs have not run. Complete jobs have run without error. Failed jobs have one of more errors. Cancelled jobs did not run.
	// Required: true
	State *string `json:"state"`

	// UTC DateTime of the start of the data to sync.
	Stopped strfmt.DateTime `json:"stopped,omitempty"`

	// This is the target of the job.
	// Required: true
	Target *string `json:"target"`

	// This is the type of job. Incremental jobs just sync changes, fully jobs sync all data.
	// Required: true
	Type *string `json:"type"`

	// { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }
	Updated strfmt.DateTime `json:"updated,omitempty"`
}

MutableBillingEntity Mutable entities are those entities that can be updated after their initial creation. swagger:model MutableBillingEntity

func (*MutableBillingEntity) Validate 

func (m *MutableBillingEntity) Validate(formats strfmt.Registry) error

Validate validates this mutable billing entity

type Notification 

type Notification struct {

	// { "description" : "If true notifications will continue to be sent until an acknowledgment is received.", "verbs":["POST","PUT","GET"] }
	// Required: true
	AckEnabled bool `json:"ackEnabled"`

	// { "description" : "The UTC DateTime when the notification was acked if it is ack enabled.", "verbs":["POST","PUT","GET"] }
	Acked strfmt.DateTime `json:"acked,omitempty"`

	// { "description" : "The action associated with the notification.", "verbs":["POST","PUT","GET"] }
	// Required: true
	Action *string `json:"action"`

	// { "description" : "ID of the user who last updated the entity.", "verbs":[] }
	ChangedBy string `json:"changedBy,omitempty"`

	// changes
	Changes []strfmt.Base64 `json:"changes"`

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`

	// { "description" : "The URL the notification will be sent to.", "verbs":["POST","PUT","GET"] }
	// Required: true
	DestinationURL *string `json:"destinationURL"`

	// { "description" : "The domain of the notification.", "verbs":["POST","PUT","GET"] }
	// Required: true
	Domain *string `json:"domain"`

	// entity
	Entity []strfmt.Base64 `json:"entity"`

	// { "description" : "The id of the entity associated with the notification.", "verbs":["POST","PUT","GET"] }
	// Required: true
	EntityID *string `json:"entityID"`

	// { "description" : "The UTC DateTime of the notification's final send attempt.", "verbs":["POST","PUT","GET"] }
	FinalSendAttempt strfmt.DateTime `json:"finalSendAttempt,omitempty"`

	// { "description" : "Format of the notification.", "verbs":["POST","PUT","GET"] }
	// Required: true
	Format *string `json:"format"`

	// { "description" : "ID of the notification.", "verbs":["POST","PUT","GET"] }
	ID string `json:"id,omitempty"`

	// { "description" : "The UTC DateTime of the notifications's last send attempt.", "verbs":["POST","PUT","GET"] }
	LastSendAttempt strfmt.DateTime `json:"lastSendAttempt,omitempty"`

	// { "description" : "The UTC DateTime of the notification's next send attempt.", "verbs":["POST","PUT","GET"] }
	NextSendAttempt strfmt.DateTime `json:"nextSendAttempt,omitempty"`

	// { "description" : "Organization associated with the notification.", "verbs":["POST","PUT","GET"] }
	// Required: true
	OrganizationID *string `json:"organizationID"`

	// { "description" : "Whether the notification has been sent.", "verbs":["POST","PUT","GET"] }
	// Required: true
	State *string `json:"state"`

	// { "description" : "The number of send attempts for this notification.", "verbs":["POST","PUT","GET"] }
	TotalSendAttempts int32 `json:"totalSendAttempts,omitempty"`

	// { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }
	Updated strfmt.DateTime `json:"updated,omitempty"`

	// { "description" : "Webhook associated with the notification.", "verbs":["POST","PUT","GET"] }
	// Required: true
	WebhookID *string `json:"webhookID"`
}

Notification Notification swagger:model Notification

func (*Notification) Validate 

func (m *Notification) Validate(formats strfmt.Registry) error

Validate validates this notification

type Organization 

type Organization struct {

	// alias
	Alias []*Alias `json:"alias"`

	// { "description" : "Stores the organizations 3rd party API keys which may be used by the system for payment gateway integration etc.", "verbs":["POST","PUT","GET"] }
	APIConfigurations []*MutableBillingEntity `json:"apiConfigurations"`

	// { "description" : "ID of the user who last updated the entity.", "verbs":[] }
	ChangedBy string `json:"changedBy,omitempty"`

	// { "description" : "The OAuth2 clients associated with the organization. In most cases an organization would not have any clients associated with their account. In the case of an APP developer, a clients would exist per an application they have developed. To further understand clients please see the client, OAuth2 API and APP development documentation.", "verbs":["POST","PUT","GET"] }
	Clients []*Client `json:"clients"`

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`

	// { "description" : "A shortcode for the organization. This is used as a short reference code for use when referring to the organization, by default this is set to the organizations name.", "verbs":["POST","PUT","GET"] }
	// Required: true
	CustomerCode *string `json:"customerCode"`

	// { "description" : "Indicates if an organization has been retired. If an organization has been retired it can still be retrieved using the appropriate flag on API requests.", "verbs":["POST","PUT","GET"] }
	// Required: true
	Deleted bool `json:"deleted"`

	// { "description" : "The dunning-lines associated with the organization. Dunning lines are used as re-try logic for invoices to attempt to reconcile the payment.", "verbs":["POST","PUT","GET"] }
	DunningLines []*DunningLine `json:"dunningLines"`

	// { "description" : "ID of the organization.", "verbs":["POST","PUT","GET"] }
	ID string `json:"id,omitempty"`

	// { "description" : "The name of the organization.", "verbs":["POST","PUT","GET"] }
	// Required: true
	Name *string `json:"name"`

	// { "description" : "The card-vault gateways associated with the organization.", "verbs":["POST","PUT","GET"] }
	OrganizationGateways []*MutableBillingEntity `json:"organizationGateways"`

	// { "description" : "The taxation-strategies associated with the organization. Taxation-strategies may be linked to product-rate-plans to specify how their tax should be calculated.", "verbs":["POST","PUT","GET"] }
	TaxationStrategies []*MutableBillingEntity `json:"taxationStrategies"`

	// { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }
	Updated strfmt.DateTime `json:"updated,omitempty"`

	// { "description" : "The WebHooks associated with the organization. These are the end-points where notifications are sent. WebHooks are added, updated and removed from the organization. Thus to add a WebHook, the webhook must be defined on this property of the organization and then the organization updated. To update a WebHook the same procedure must be followed, first retrieving the organization followed by updating the appropriate WebHook, finally the organization is updated.", "verbs":["POST","PUT","GET"] }
	// Required: true
	Webhooks []*MutableBillingEntity `json:"webhooks"`
}

Organization Organization within which all your BillForward interactions are scoped. swagger:model Organization

func (*Organization) Validate 

func (m *Organization) Validate(formats strfmt.Registry) error

Validate validates this organization

type Payment 

type Payment struct {

	// { "description" : "Actual monetary value of the payment. This is real value of the payment amount, thus the amount of currency received for this payment. A coupon has a real value of zero, even though the nominal amount it pays may be greater than zero.", "verbs":["POST","PUT","GET"] }
	// Required: true
	ActualValue *float64 `json:"actualValue"`

	// { "description" : "ID of the user who last updated the entity.", "verbs":[] }
	ChangedBy string `json:"changedBy,omitempty"`

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`

	// { "description" : "CRM ID of the invoice.", "verbs":["POST","PUT","GET"] }
	// Required: true
	CrmID *string `json:"crmID"`

	// { "description" : "The currency of the payment specified by a three character ISO 4217 currency code.", "verbs":["POST","PUT","GET"] }
	// Required: true
	Currency *string `json:"currency"`

	// { "description" : "Payment gateway associated with the payment", "verbs":["POST","PUT","GET"] }
	// Required: true
	Gateway *string `json:"gateway"`

	// { "description" : "ID of the payment.", "verbs":["POST","PUT","GET"] }
	ID string `json:"id,omitempty"`

	// { "description" : "ID of the invoice associated with the payment. This may be null when a payment is not explicitly associated with an invoice. Payments may be used across multiple invoices.", "verbs":["POST","PUT","GET"] }
	// Required: true
	InvoiceID *string `json:"invoiceID"`

	// { "description" : "Nominal value of the payment. This is the theoretical value of the payment, thus the value this payment can pay off an invoice. For example a coupon has a nominal value of the discount, and the actual value is zero.", "verbs":["POST","PUT","GET"] }
	// Required: true
	NominalValue *float64 `json:"nominalValue"`

	// { "description" : "ID of the organization associated with the payment.", "verbs":["POST","PUT","GET"] }
	// Required: true
	OrganizationID *string `json:"organizationID"`

	// { "description" : "ID of the payment method associated with the payment.", "verbs":["POST","PUT","GET"] }
	// Required: true
	PaymentMethodID *string `json:"paymentMethodID"`

	// { "description" : "UTC DateTime specifying when payment was received for the invoice.", "verbs":["POST","PUT","GET"] }
	PaymentReceived strfmt.DateTime `json:"paymentReceived,omitempty"`

	// { "description" : "ID of the refund associated with the payment.", "verbs":["POST","PUT","GET"] }
	// Required: true
	RefundID *string `json:"refundID"`

	// { "description" : "Refunded nominal value of the payment.", "verbs":["POST","PUT","GET"] }
	// Required: true
	RefundedValue *float64 `json:"refundedValue"`

	// { "description" : "Remaining nominal value of the payment not used. In the case when a payment is used across a range of invoices a payment may be used multiple times, each use reducing the available blance of the payment.", "verbs":["POST","PUT","GET"] }
	// Required: true
	RemainingNominalValue *float64 `json:"remainingNominalValue"`

	// { "description" : "Type of payment.", "verbs":["POST","PUT","GET"] }
	// Required: true
	Type *string `json:"type"`

	// { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }
	Updated strfmt.DateTime `json:"updated,omitempty"`
}

Payment Payment swagger:model Payment

func (*Payment) Validate 

func (m *Payment) Validate(formats strfmt.Registry) error

Validate validates this payment

type PaymentMethod 

type PaymentMethod struct {

	// { "description" : "ID of the account associated with the payment-method.", "verbs":["POST","GET"] }
	// Required: true
	AccountID *string `json:"accountID"`

	// { "description" : "Name of the card holder", "verbs":["POST","PUT","GET"] }
	CardHolderName string `json:"cardHolderName,omitempty"`

	// { "description" : "Type of the card. In the case of card payment methods this is the payment type, for example VISA, MasterCard.", "verbs":["POST","GET"] }
	CardType string `json:"cardType,omitempty"`

	// { "description" : "ID of the user who last updated the entity.", "verbs":[] }
	ChangedBy string `json:"changedBy,omitempty"`

	// country
	Country string `json:"country,omitempty"`

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`

	// { "description" : "CRM ID of the product-rate-plan.", "verbs":] }
	CrmID string `json:"crmID,omitempty"`

	// {"default" : "false", "description" : "Indicates if this is the default payment method for the account.", "verbs":["GET","POST","PUT"]  }
	DefaultPaymentMethod *bool `json:"defaultPaymentMethod,omitempty"`

	// {"default" : "false", "description" : "Indicates if a payment-method has been retired. If a payment-method has been retired it can still be retrieved using the appropriate flag on API requests. Generally payment-methods will be retired by customers wanting to remove the payment method from their account. Caution should be used when requested deleted payment methods.", "verbs":["GET"] }
	Deleted *bool `json:"deleted,omitempty"`

	// { "description" : "Description of the payment-method.", "verbs":["POST","PUT","GET"] }
	Description string `json:"description,omitempty"`

	// { "description" : "In the case of card payment methods this is the expiry date of the card, format should be MMYY including leading 0's. For example 0115 for January 2015.", "verbs":["POST","GET"] }
	// Required: true
	ExpiryDate *string `json:"expiryDate"`

	// expiry month
	ExpiryMonth int32 `json:"expiryMonth,omitempty"`

	// expiry year
	ExpiryYear int32 `json:"expiryYear,omitempty"`

	// first six
	FirstSix string `json:"firstSix,omitempty"`

	// { "description" : "Gateway type for payment-method.", "verbs":["POST","GET"] }
	// Required: true
	Gateway *string `json:"gateway"`

	// { "description" : "ID of the payment-method.", "verbs":["GET"] }
	ID string `json:"id,omitempty"`

	// {"description":"IP address associated with this payment method.","verbs":["POST","PUT","GET"]}
	IPAddress string `json:"ipAddress,omitempty"`

	// {"description":"Country of the IP address associated with this payment method.","verbs":["POST","PUT","GET"]}
	IPAddressCountry string `json:"ipAddressCountry,omitempty"`

	// last four
	LastFour string `json:"lastFour,omitempty"`

	// link ID
	// Required: true
	LinkID *string `json:"linkID"`

	// { "description" : "Name of the payment-method.", "verbs":["POST","PUT","GET"] }
	// Required: true
	Name *string `json:"name"`

	// organization ID
	OrganizationID string `json:"organizationID,omitempty"`

	// province
	Province string `json:"province,omitempty"`

	// { "description" : "State of the payment-method.", "verbs":["POST","GET"] }
	// Required: true
	State *string `json:"state"`

	// { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }
	Updated strfmt.DateTime `json:"updated,omitempty"`
}

PaymentMethod PaymentMethod swagger:model PaymentMethod

func (*PaymentMethod) Validate 

func (m *PaymentMethod) Validate(formats strfmt.Registry) error

Validate validates this payment method

type PaymentMethodPagedMetadata 

type PaymentMethodPagedMetadata struct {

	// {"description":"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.","verbs":["GET","PUT","POST"]}
	// Required: true
	CurrentOffset *int32 `json:"currentOffset"`

	// {"description":"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.","verbs":["GET","PUT","POST"]}
	// Required: true
	CurrentPage *int32 `json:"currentPage"`

	// {"description":"Number of milliseconds taken by API to calculate response.","verbs":["GET","PUT","POST"]}
	// Required: true
	ExecutionTime *int64 `json:"executionTime"`

	// {"description":"Paging parameter. URL fragment that can be used to fetch next page of results.","verbs":["GET","PUT","POST"]}
	// Required: true
	NextPage *string `json:"nextPage"`

	// {"default":10,"description":"Paging parameter. Describes how many records you requested.","verbs":["GET","PUT","POST"]}
	// Required: true
	RecordsRequested *int32 `json:"recordsRequested"`

	// {"description":"Describes how many records were returned by your query.","verbs":["GET","PUT","POST"]}
	// Required: true
	RecordsReturned *int32 `json:"recordsReturned"`

	// {"description":"The results returned by your query.","verbs":["GET","PUT","POST"]}
	// Required: true
	Results []*PaymentMethod `json:"results"`
}

PaymentMethodPagedMetadata payment method paged metadata swagger:model PaymentMethodPagedMetadata

func (*PaymentMethodPagedMetadata) Validate 

func (m *PaymentMethodPagedMetadata) Validate(formats strfmt.Registry) error

Validate validates this payment method paged metadata 

type PaymentMethodSubscriptionLink struct {

	// { "description" : "ID of the user who last updated the entity.", "verbs":[] }
	ChangedBy string `json:"changedBy,omitempty"`

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`

	// { "description" : "CRM ID of the product-rate-plan.", "verbs":["POST","PUT","GET"] }
	CrmID string `json:"crmID,omitempty"`

	// deleted
	Deleted *bool `json:"deleted,omitempty"`

	// { "description" : "", "verbs":["GET"] }
	ID string `json:"id,omitempty"`

	// organization ID
	OrganizationID string `json:"organizationID,omitempty"`

	// payment method
	PaymentMethod *PaymentMethod `json:"paymentMethod,omitempty"`

	// { "description" : "Payment method to add to subscription.", "verbs":["POST","GET"] }
	// Required: true
	PaymentMethodID *string `json:"paymentMethodID"`

	// { "description" : "Subscription to add payment method to.", "verbs":["POST","GET"] }
	// Required: true
	SubscriptionID *string `json:"subscriptionID"`

	// { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }
	Updated strfmt.DateTime `json:"updated,omitempty"`
}

PaymentMethodSubscriptionLink PaymentMethodSubscriptionLink swagger:model PaymentMethodSubscriptionLink

func (*PaymentMethodSubscriptionLink) Validate 

func (m *PaymentMethodSubscriptionLink) Validate(formats strfmt.Registry) error

Validate validates this payment method subscription link

type PaymentPagedMetadata 

type PaymentPagedMetadata struct {

	// {"description":"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.","verbs":["GET","PUT","POST"]}
	// Required: true
	CurrentOffset *int32 `json:"currentOffset"`

	// {"description":"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.","verbs":["GET","PUT","POST"]}
	// Required: true
	CurrentPage *int32 `json:"currentPage"`

	// {"description":"Number of milliseconds taken by API to calculate response.","verbs":["GET","PUT","POST"]}
	// Required: true
	ExecutionTime *int64 `json:"executionTime"`

	// {"description":"Paging parameter. URL fragment that can be used to fetch next page of results.","verbs":["GET","PUT","POST"]}
	// Required: true
	NextPage *string `json:"nextPage"`

	// {"default":10,"description":"Paging parameter. Describes how many records you requested.","verbs":["GET","PUT","POST"]}
	// Required: true
	RecordsRequested *int32 `json:"recordsRequested"`

	// {"description":"Describes how many records were returned by your query.","verbs":["GET","PUT","POST"]}
	// Required: true
	RecordsReturned *int32 `json:"recordsReturned"`

	// {"description":"The results returned by your query.","verbs":["GET","PUT","POST"]}
	// Required: true
	Results []*Payment `json:"results"`
}

PaymentPagedMetadata payment paged metadata swagger:model PaymentPagedMetadata

func (*PaymentPagedMetadata) Validate 

func (m *PaymentPagedMetadata) Validate(formats strfmt.Registry) error

Validate validates this payment paged metadata

type PendingComponentValueChange 

type PendingComponentValueChange struct {

	// at
	At strfmt.DateTime `json:"at,omitempty"`

	// discard Http verb
	DiscardHTTPVerb string `json:"discardHttpVerb,omitempty"`

	// discard Url
	DiscardURL string `json:"discardUrl,omitempty"`

	// value
	Value int32 `json:"value,omitempty"`
}

PendingComponentValueChange pending component value change swagger:model PendingComponentValueChange

func (*PendingComponentValueChange) Validate 

func (m *PendingComponentValueChange) Validate(formats strfmt.Registry) error

Validate validates this pending component value change

type PricingComponent 

type PricingComponent interface {
	runtime.Validatable

	// { "description" : "", "default" : "", "verbs":["POST","GET"] }
	// Required: true
	AtType() string
	SetAtType(string)

	// { "description" : "ID of the user who last updated the entity.", "verbs":[] }
	ChangedBy() string
	SetChangedBy(string)

	// { "description" : "The charge model of the pricing-component.", "verbs":["POST","PUT","GET"] }
	// Required: true
	ChargeModel() *string
	SetChargeModel(*string)

	// { "description" : "The charge type of the pricing-component.", "verbs":["POST","PUT","GET"] }
	// Required: true
	ChargeType() *string
	SetChargeType(*string)

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created() strfmt.DateTime
	SetCreated(strfmt.DateTime)

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	CrmID() string
	SetCrmID(string)

	// { "description" : "The default quantity of the pricing-component. If no value is supplied on a subscription this value will be used. This is useful for setting an expected purchase level of for introducing new pricing components to existing subscriptions and not having to back-fill values", "verbs":["POST","PUT","GET"] }
	// Required: true
	DefaultQuantity() *int32
	SetDefaultQuantity(*int32)

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	Description() string
	SetDescription(string)

	// {"default":"<span class=\"label label-default\">delayed</span>","description":"Default behaviour when a value is downgraded using this pricing component, this behaviour can be overridden when changing the value.<br><span class=\"label label-default\">immediate</span> &mdash; Downgrade will apply at the time the request is made.<br><span class=\"label label-default\">delayed</span> &mdash; Downgrade will apply at the end of the current billing cycle.","verbs":["POST","GET"]}
	DowngradeMode() string
	SetDowngradeMode(string)

	// { "description" : "", "verbs":["GET"] } When associating a pricing component with a product rate plan, this ID should be used.
	// Required: true
	ID() *string
	SetID(*string)

	// { "default" : "Aggregated",  "description" : "For <span class=\"label label-default\">setup</span> pricing components <span class=\"label label-default\">Immediate</span> invoicing will result in an invoice being issued on subscription being set to the AwaitingPayment state, irrespective of the subscription start date. <span class=\"label label-default\">Aggregated</span> invoicing will add a charge to the first invoice of the subscription.", "verbs":["POST","PUT","GET"] }
	InvoicingType() string
	SetInvoicingType(string)

	// { "description" : "The maximum quantity of the pricing-component.", "verbs":[] }
	MaxQuantity() int32
	SetMaxQuantity(int32)

	// { "default" : "0", "description" : "The minimum quantity of the pricing-component.", "verbs":[] }
	MinQuantity() int32
	SetMinQuantity(int32)

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	// Required: true
	Name() *string
	SetName(*string)

	// { "description" : "", "verbs":[] }
	// Required: true
	OrganizationID() *string
	SetOrganizationID(*string)

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	// Required: true
	ProductRatePlanID() *string
	SetProductRatePlanID(*string)

	// {"description":"A friendly non-unique name used to identify this pricing-component","verbs":["POST","PUT","GET"]}
	PublicName() string
	SetPublicName(string)

	// {  "default" : "[]", "description" : "The pricing-component-tiers associated with the pricing-component.", "verbs":["POST","PUT","GET"] }
	Tiers() []*PricingComponentTier
	SetTiers([]*PricingComponentTier)

	// { "description" : "The unit-of-measure associated with the pricing-component.", "verbs":["POST","PUT","GET"] }
	UnitOfMeasure() *UnitOfMeasure
	SetUnitOfMeasure(*UnitOfMeasure)

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	// Required: true
	UnitOfMeasureID() *string
	SetUnitOfMeasureID(*string)

	// { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }
	Updated() strfmt.DateTime
	SetUpdated(strfmt.DateTime)

	// {"default":"<span class=\"label label-default\">immediate</span>","description":"Default behaviour when a value is upgraded using this pricing component, this behaviour can be overridden when changing the value.<br><span class=\"label label-default\">immediate</span> &mdash; Upgrade will apply at the time the request is made.<br><span class=\"label label-default\">delayed</span> &mdash; Upgrade will apply at the end of the current billing cycle.","verbs":["POST","GET"]}
	UpgradeMode() string
	SetUpgradeMode(string)

	// { "default" : "current time", "description" : "The DateTime specifying when the pricing-component is valid from.", "verbs":["POST","PUT","GET"] }
	// Required: true
	ValidFrom() *strfmt.DateTime
	SetValidFrom(*strfmt.DateTime)

	// {  "default" : "null", "description" : "The UTC DateTime specifying when the pricing-component is valid till.", "verbs":["POST","PUT","GET"] }
	ValidTill() *strfmt.DateTime
	SetValidTill(*strfmt.DateTime)

	// { "description" : "", "verbs":["GET"] }
	// Required: true
	VersionID() *string
	SetVersionID(*string)
}

PricingComponent pricing component swagger:discriminator PricingComponent @type

func UnmarshalPricingComponent 

func UnmarshalPricingComponent(reader io.Reader, consumer runtime.Consumer) (PricingComponent, error)

UnmarshalPricingComponent unmarshals polymorphic PricingComponent

func UnmarshalPricingComponentSlice 

func UnmarshalPricingComponentSlice(reader io.Reader, consumer runtime.Consumer) ([]PricingComponent, error)

UnmarshalPricingComponentSlice unmarshals polymorphic slices of PricingComponent

type PricingComponentQuantityRequest 

type PricingComponentQuantityRequest struct {

	// { "description" : "Percentage to be discounted", "verbs":["POST","GET"] }
	PercentageDiscount float64 `json:"percentageDiscount,omitempty"`

	// pricing component
	// Required: true
	PricingComponent *string `json:"pricingComponent"`

	// quantity
	// Required: true
	Quantity *int64 `json:"quantity"`
}

PricingComponentQuantityRequest pricing component quantity request swagger:model PricingComponentQuantityRequest

func (*PricingComponentQuantityRequest) Validate 

func (m *PricingComponentQuantityRequest) Validate(formats strfmt.Registry) error

Validate validates this pricing component quantity request

type PricingComponentTier 

type PricingComponentTier struct {

	// { "description" : "ID of the user who last updated the entity.", "verbs":[] }
	ChangedBy string `json:"changedBy,omitempty"`

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	CrmID string `json:"crmID,omitempty"`

	// { "description" : "", "verbs":["GET"] }
	ID string `json:"id,omitempty"`

	// { "description" : "The lower threshold of the tier.", "verbs":["POST","PUT","GET"] }
	LowerThreshold int32 `json:"lowerThreshold,omitempty"`

	// { "description" : "Organization associated with the pricing-component-tier.", "verbs":[] }
	OrganizationID string `json:"organizationID,omitempty"`

	// { "description" : "Cost associated with tier. When the pricingType is fixed this is the total value. When pricingType is unit, this is the cost of each unit. ", "verbs":["POST","PUT","GET"] }
	// Required: true
	Price *float64 `json:"price"`

	// { "description" : "ID of the pricing-component associated with the pricing-component-tier.", "verbs":["POST","PUT","GET"] }
	PricingComponentID string `json:"pricingComponentID,omitempty"`

	// { "description" : "Version ID of the associated pricing-component", "verbs":["POST","PUT","GET"] }
	// Required: true
	PricingComponentVersionID *string `json:"pricingComponentVersionID"`

	// { "description" : "Pricing calculation used to price items in this pricing tier. Unit pricing means every distinct value is used in the calculation. Fixed means that the total price of the tier is fixed regardless of the purchased amount.", "verbs":["POST","PUT","GET"] }
	// Required: true
	PricingType *string `json:"pricingType"`

	// { "description" : "ID of the product-rate-plan associated with the pricing-component-tier.", "verbs":["POST","PUT","GET"] }
	ProductRatePlanID string `json:"productRatePlanID,omitempty"`

	// {  "default" : "&infin;",  "description" : "The upper threshold of the tier. If this is left null the tier will be infinite", "verbs":["POST","PUT","GET"] }
	UpperThreshold int32 `json:"upperThreshold,omitempty"`
}

PricingComponentTier PricingComponentTier swagger:model PricingComponentTier

func (*PricingComponentTier) Validate 

func (m *PricingComponentTier) Validate(formats strfmt.Registry) error

Validate validates this pricing component tier

type PricingComponentValue 

type PricingComponentValue struct {

	// { "description" : "<p>The appliesFrom can be left null. If appliesFrom is set, it indicates when a value came into effect.</p>", "verbs":["POST","PUT","GET"] }
	AppliesFrom strfmt.DateTime `json:"appliesFrom,omitempty"`

	// { "description" : "<p>For <span class=\"label label-default\">setup</span>, <span class=\"label label-default\">subscription</span>, and <span class=\"label label-default\">arrears</span> pricing components if appliesTill is specificed the value will be used whilst the time has not been reached. If appliesTill is null the pricing component value will be used until a new value is added. When a new value is added appliesTill will be set to the time the new value will take effect.</p><p><span class=\"label label-default\">usage</span> pricing applies to the previous billing period as it is charged in-arrears. When adding usage a new pricing component value should be added with appliesTill set to the end of the usages billing period. For example a monthly subscription results in an invoice being generated on the 1<sup>st</sup> of March, the previous months usage period ended on the same date. A usage value should be added to the subscription with the appliesTill set to the invoices periodStart, the 1<sup>st</sup> of March.</p>", "verbs":["POST","PUT","GET"] }
	AppliesTill strfmt.DateTime `json:"appliesTill,omitempty"`

	// { "description" : "ID of the user who last updated the entity.", "verbs":[] }
	ChangedBy string `json:"changedBy,omitempty"`

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`

	// { "description" : "", "verbs":["GET"] }
	// Required: true
	ID *string `json:"id"`

	// { "description" : "", "verbs":["GET"] }
	OrganizationID string `json:"organizationID,omitempty"`

	// pending change
	PendingChange *PendingComponentValueChange `json:"pendingChange,omitempty"`

	// { "description" : "", "verbs":["POST","GET"] }
	// Required: true
	PricingComponentID *string `json:"pricingComponentID"`

	// { "description" : "Name of the pricing-component associated with the pricing-component-value.", "verbs":["GET"] }
	PricingComponentName string `json:"pricingComponentName,omitempty"`

	// { "description" : "Value can be left null if setting the pricing component value on the subscription directly.", "verbs":["GET", "POST"] }
	// Required: true
	SubscriptionID *string `json:"subscriptionID"`

	// { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }
	Updated strfmt.DateTime `json:"updated,omitempty"`

	// { "description" : "Quantity of a particular pricing component the subscription should have. For example if you have a pricing component for widgets, where $5/widget/month and you set the value to 10 then the customer will be charged $50 ($5 x 10) monthly.", "verbs":["POST","PUT","GET"] }
	// Required: true
	Value *int32 `json:"value"`

	// { "description" : "", "verbs":["GET"] }
	VersionID string `json:"versionID,omitempty"`
}

PricingComponentValue PricingComponentValue swagger:model PricingComponentValue

func (*PricingComponentValue) Validate 

func (m *PricingComponentValue) Validate(formats strfmt.Registry) error

Validate validates this pricing component value

type Product 

type Product struct {

	// {"description":"","verbs":[]}
	AccountID string `json:"accountID,omitempty"`

	// { "description" : "ID of the user who last updated the entity.", "verbs":[] }
	ChangedBy string `json:"changedBy,omitempty"`

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`

	// {"description":"Customer-relationship-management ID of the product.","verbs":["GET","PUT","POST"]}
	CrmID string `json:"crmID,omitempty"`

	// {"description":"","verbs":["GET"]}
	// Required: true
	Deleted bool `json:"deleted"`

	// {"description":"A description &mdash; for your benefit &mdash; of the product. For example: you could explain what service this product entitles a customer to.","verbs":["POST","PUT","GET"]}
	// Required: true
	Description *string `json:"description"`

	// {"description":"Number of length-measures which constitute the product's period.","verbs":["POST","PUT","GET"]}
	// Required: true
	Duration *int32 `json:"duration"`

	// {"description":"Measure describing the magnitude of the product's period.","verbs":["POST","PUT","GET"]}
	// Required: true
	DurationPeriod *string `json:"durationPeriod"`

	// {"description":"ID uniquely identifying this product.","verbs":["GET"]}
	ID string `json:"id,omitempty"`

	// metadata
	Metadata DynamicMetadata `json:"metadata,omitempty"`

	// {"description":"A unique name &mdash; for your benefit &mdash; used to identify this product within BillForward. It should reflect the fact that this product confers some service to a customer (e.g. \"Gold membership\").<br>The product can also be defined by the frequency with which it recurs (e.g. \"Monthly Gold membership\").<br>Remember also that rate plans can override the timing prescribed by their product. If you intend to override that timing, you may consider the product's period duration to be an unimportant factor when it comes to naming it.","verbs":["POST","PUT","GET"]}
	// Required: true
	Name *string `json:"name"`

	// payment terms
	PaymentTerms int64 `json:"paymentTerms,omitempty"`

	// {"default":"recurring","description":"The frequency of the product &mdash; either recurring or non-recurring.","verbs":["POST","PUT","GET"]}
	// Required: true
	ProductType *string `json:"productType"`

	// {"description":"A friendly non-unique name used to identify this product","verbs":["POST","PUT","GET"]}
	PublicName string `json:"publicName,omitempty"`

	// {"description":"","verbs":[]}
	StartDate strfmt.DateTime `json:"startDate,omitempty"`

	// {"default":0,"description":"Number of trial-length-measures which constitute the product's trial period","verbs":["POST","PUT","GET"]}
	// Required: true
	Trial *int32 `json:"trial"`

	// {"default":"none","description":"Measure describing the magnitude of the product's trial period.","verbs":["POST","PUT","GET"]}
	// Required: true
	TrialPeriod *string `json:"trialPeriod"`

	// { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }
	Updated strfmt.DateTime `json:"updated,omitempty"`
}

Product Product swagger:model Product

func (*Product) Validate 

func (m *Product) Validate(formats strfmt.Registry) error

Validate validates this product

type ProductPagedMetadata 

type ProductPagedMetadata struct {

	// {"description":"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.","verbs":["GET","PUT","POST"]}
	// Required: true
	CurrentOffset *int32 `json:"currentOffset"`

	// {"description":"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.","verbs":["GET","PUT","POST"]}
	// Required: true
	CurrentPage *int32 `json:"currentPage"`

	// {"description":"Number of milliseconds taken by API to calculate response.","verbs":["GET","PUT","POST"]}
	// Required: true
	ExecutionTime *int64 `json:"executionTime"`

	// {"description":"Paging parameter. URL fragment that can be used to fetch next page of results.","verbs":["GET","PUT","POST"]}
	// Required: true
	NextPage *string `json:"nextPage"`

	// {"default":10,"description":"Paging parameter. Describes how many records you requested.","verbs":["GET","PUT","POST"]}
	// Required: true
	RecordsRequested *int32 `json:"recordsRequested"`

	// {"description":"Describes how many records were returned by your query.","verbs":["GET","PUT","POST"]}
	// Required: true
	RecordsReturned *int32 `json:"recordsReturned"`

	// {"description":"The results returned by your query.","verbs":["GET","PUT","POST"]}
	// Required: true
	Results []*Product `json:"results"`
}

ProductPagedMetadata product paged metadata swagger:model ProductPagedMetadata

func (*ProductPagedMetadata) Validate 

func (m *ProductPagedMetadata) Validate(formats strfmt.Registry) error

Validate validates this product paged metadata

type ProductRatePlan 

type ProductRatePlan struct {

	// {"default":"(empty list)","description":"List of AggregatingComponents &mdash; these describe pricing components whose prices should be recalculated upon invoice aggregation. For example: two subscriptions' individual consumptions may be neither of them large enough to achieve bulk-buy discounts. When aggregated, though, the same two subscriptions' consumption may add up to a quantity which does merit a bulk buy discount within your tiering system.","verbs":["POST"]}
	AggregatingComponents []*AggregatingComponent `json:"aggregatingComponents"`

	// { "description" : "ID of the user who last updated the entity.", "verbs":[] }
	ChangedBy string `json:"changedBy,omitempty"`

	// {"default":"true","description":"Whether invoices are created if they have a zero valued cost before any discounts are applied.","verbs":["POST","PUT","GET"] }
	// Required: true
	CreateZeroValuedInvoices bool `json:"createZeroValuedInvoices"`

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`

	// {"description":"Customer-relationship-management ID of the rate plan.","verbs":["GET","PUT","POST"]}
	CrmID string `json:"crmID,omitempty"`

	// {"description":"The currency of the product-rate-plan &mdash; as specified by a three-character ISO 4217 currency code (i.e. USD).","verbs":["POST","GET"]}
	// Required: true
	Currency *string `json:"currency"`

	// {"description":"Number of length-measures which constitute the rate plan's period. If left unspecified: the rate plan will use the same `duration` number as the Product to which it belongs.","verbs":["POST","GET"]}
	Duration int32 `json:"duration,omitempty"`

	// {"description":"Measure describing the magnitude of the rate plan's period. If left unspecified: the rate plan will use the same `durationPeriod` magnitude as the Product to which it belongs.","verbs":["POST","GET"]}
	// Required: true
	DurationPeriod *string `json:"durationPeriod"`

	// {"default":"None","description":"The action that should be taken, should an invoice for some subscription to this rate plan remain unpaid despite the dunning period's being exceeded.<br><span class=\"label label-default\">CancelSubscription</span> &mdash; Demotes the subscription to the `Failed` state as soon as the dunning period is exceeded.<br><span class=\"label label-default\">None</span> &mdash; The subscription is allowed to continue in the `AwaitingPayment` state indefinitely even if the dunning period is exceeded.For slow payment cycles &mdash; or when manual invoice remediation is common &mdash; <span class=\"label label-default\">None</span> is recommended.<br>In a heavily-automated SaaS environment, automatic cancellation via <span class=\"label label-default\">CancelSubscription</span> is recommended.","verbs":["POST","PUT","GET"]}
	// Required: true
	FailedPaymentBehaviour *string `json:"failedPaymentBehaviour"`

	// {"description":"A list linking \"Fixed-Term Definitions\" to the rate plan.","verbs":["POST","PUT","GET"]}
	FixedTermDefinitions []*MutableBillingEntity `json:"fixedTermDefinitions"`

	// {"description":"ID uniquely identifying this rate plan.","verbs":["GET"]}
	ID string `json:"id,omitempty"`

	// {"default":"<span class=\"label label-default\">Immediate</span>","description":"The strategy for how invoices for this plan will be issued.<br><span class=\"label label-default\">Immediate</span> &mdash; All generated invoices move immediately to the 'Unpaid' state &mdash; beginning the payment pursuit process.<br><span class=\"label label-default\">Delayed</span> &mdash; All generated invoices begin in the 'Pending' state. An 'Issue Invoice' amendment is scheduled (based on the rate plan's `issueDuration` and `issuePeriod`) that will move the invoice to the 'Unpaid' state (beginning the payment pursuit process) in accordance with the rate plan's issuance schedule.<br><span class=\"label label-default\">Manual</span> &mdash; All generated invoices sit in the 'Pending' state &mdash; they will not be issued to the customer unless explicit action is taken. This gives you an opportunity to review or recalculate the invoice."verbs":["POST","GET"]}
	InvoiceIssueType string `json:"invoiceIssueType,omitempty"`

	// {"description":"Number of issue-length-measures between issuance of invoices for this rate plan.""verbs":["POST","GET"]}
	IssueDuration int32 `json:"issueDuration,omitempty"`

	// {"description":"Measure describing the magnitude of the invoice issuance period.","verbs":["POST","GET"]}
	IssuePeriod string `json:"issuePeriod,omitempty"`

	// { "description" : "Add metadata.", "verbs":["POST"] }
	Metadata DynamicMetadata `json:"metadata,omitempty"`

	// {"default":"CreditAccount","description":"The action that should be taken, should the pro-rata calculation result in a negative value.<br><span class=\"label label-default\">NoCharge</span> &mdash; Don't return to the customer any money.<br><span class=\"label label-default\">CreditAccount</span> &mdash; Credit the customer's account with the amount.","verbs":["POST","PUT","GET"]}
	// Required: true
	MigrationBehaviour *string `json:"migrationBehaviour"`

	// {"description":"A friendly name &mdash; for your benefit &mdash; used to identify this rate plan within some product in BillForward. The name should reflect the fact that this rate plan provides to the customer a price tiering system within which a subscription to its Product can be made. <br>The rate plan's name could describe the nature of its price tiering (e.g. \"Default pricing\", \"Student pricing\").<br>Remember also that rate plans can override the timing prescribed by their product. If your rate plan is defined by its overriding the default timing of its product, then that can be reflected in that rate plan's name. (e.g. \"Student pricing - Annual\").","verbs":["POST","PUT","GET"]}
	// Required: true
	Name *string `json:"name"`

	// payment terms
	PaymentTerms int64 `json:"paymentTerms,omitempty"`

	PricingComponents []PricingComponent `json:"pricingComponents"`

	// {"default":"WithCoupon","description":"The pro-rata mode for the rate plan. <br><span class=\"label label-default\">None</span> &mdash; The pro-rata cost for upgrades will be ignored.<br><span class=\"label label-default\">WithCoupon</span> &mdash; The pro-rata cost for upgrades will be calculated based on the time remaining for the subscription. Discounts from any attached coupons will be deducted from the pro-rated cost.<br><span class=\"label label-default\">WithoutCoupon</span> &mdash; The pro-rata cost for upgrades will be calculated based on the time remaining for the subscription. Discounts from any attached coupons will not be deducted from the pro-rated cost. ","verbs":[]}
	// Required: true
	ProRataMode *string `json:"proRataMode"`

	// {"description":"The product to which this rate plan belongs. A product is essentially a collection of rate plans, and describes the service conferred to a customer upon subscription to any of said product's rate plans. The product serves also as a template from which its rate plans can infer default attributes.","verbs":["POST","GET"]}
	Product *Product `json:"product,omitempty"`

	// {"description":"ID of the product to which this rate plan belongs. A product is essentially a collection of rate plans, and describes the service conferred to a customer upon subscription to any of said product's rate plans. The product serves also as a template from which its rate plans can infer default attributes.","verbs":["POST","GET"]}
	// Required: true
	ProductID *string `json:"productID"`

	// {"default":"recurring","description":"The frequency of the rate plan &mdash; either recurring or non-recurring. If left unspecified: the rate plan will use the same `productType` frequency as the Product to which it belongs.","verbs":["POST","PUT","GET"]}
	ProductType string `json:"productType,omitempty"`

	// {"description":"A friendly non-unique name used to identify this product-rate-plan","verbs":["POST","PUT","GET"]}
	PublicName string `json:"publicName,omitempty"`

	// {"description":"The current status of the rate plan.","verbs":[]}
	Status string `json:"status,omitempty"`

	// {"default":"inclusive","description":"The tax status of the product-rate-plan &mdash; either inclusive or exclusive.<br><span class=\"label label-default\">exclusive</span>pricing indicates that the cost of the Pricing Components do not include tax; when BillForward generates an Invoice, the tax will be calculated with this price as a base. <br>Tax-<span class=\"label label-default\">inclusive</span>pricing indicates that the Pricing components include Tax. BillForward will still calculate tax on each invoice. Tax will be calculated from the sales price.","verbs":["POST","PUT","GET"]}
	// Required: true
	TaxStatus *string `json:"taxStatus"`

	// {"description":"A list linking taxation strategies to the rate plan.","verbs":["POST","GET","PUT"]}
	Taxation []*MutableBillingEntity `json:"taxation"`

	// {"default":0,"description":"Number of trial-length-measures which constitute the rate plan's trial period. If left unspecified: the rate plan will use the same `trial` number as the Product to which it belongs.","verbs":["POST","PUT","GET"]}
	Trial int32 `json:"trial,omitempty"`

	// {"default":"none","description":"Measure describing the magnitude of the rate plan's trial period. If left unspecified: the rate plan will use the same `trialPeriod` magnitude as the Product to which it belongs.","verbs":["POST","PUT","GET"]}
	TrialPeriod string `json:"trialPeriod,omitempty"`

	// { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }
	Updated strfmt.DateTime `json:"updated,omitempty"`

	// {"description":"The UTC DateTime specifying when the rate plan is valid from.","verbs":["GET"]}
	ValidFrom strfmt.DateTime `json:"validFrom,omitempty"`

	// {"description":"The UTC DateTime specifying when the product-rate-plan is valid till.","verbs":["GET"]}
	ValidTill strfmt.DateTime `json:"validTill,omitempty"`
}

ProductRatePlan A rate plan describes a pricing system under which a subscription can be made to a product. swagger:model ProductRatePlan

func (ProductRatePlan) MarshalJSON 

func (m ProductRatePlan) MarshalJSON() ([]byte, error)

MarshalJSON marshals this object with a polymorphic type to a JSON structure

func (*ProductRatePlan) UnmarshalJSON 

func (m *ProductRatePlan) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this object with a polymorphic type from a JSON structure

func (*ProductRatePlan) Validate 

func (m *ProductRatePlan) Validate(formats strfmt.Registry) error

Validate validates this product rate plan

type ProductRatePlanPagedMetadata 

type ProductRatePlanPagedMetadata struct {

	// {"description":"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.","verbs":["GET","PUT","POST"]}
	// Required: true
	CurrentOffset *int32 `json:"currentOffset"`

	// {"description":"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.","verbs":["GET","PUT","POST"]}
	// Required: true
	CurrentPage *int32 `json:"currentPage"`

	// {"description":"Number of milliseconds taken by API to calculate response.","verbs":["GET","PUT","POST"]}
	// Required: true
	ExecutionTime *int64 `json:"executionTime"`

	// {"description":"Paging parameter. URL fragment that can be used to fetch next page of results.","verbs":["GET","PUT","POST"]}
	// Required: true
	NextPage *string `json:"nextPage"`

	// {"default":10,"description":"Paging parameter. Describes how many records you requested.","verbs":["GET","PUT","POST"]}
	// Required: true
	RecordsRequested *int32 `json:"recordsRequested"`

	// {"description":"Describes how many records were returned by your query.","verbs":["GET","PUT","POST"]}
	// Required: true
	RecordsReturned *int32 `json:"recordsReturned"`

	// {"description":"The results returned by your query.","verbs":["GET","PUT","POST"]}
	// Required: true
	Results []*ProductRatePlan `json:"results"`
}

ProductRatePlanPagedMetadata product rate plan paged metadata swagger:model ProductRatePlanPagedMetadata

func (*ProductRatePlanPagedMetadata) Validate 

func (m *ProductRatePlanPagedMetadata) Validate(formats strfmt.Registry) error

Validate validates this product rate plan paged metadata

type Profile 

type Profile struct {

	// { "description" : "", "verbs":["GET"] }
	// Required: true
	AccountID *string `json:"accountID"`

	// { "description" : "Any additional information", "verbs":["POST","PUT","GET"] }
	AdditionalInformation string `json:"additionalInformation,omitempty"`

	// { "description" : "Address associated with the profile", "verbs":["POST","PUT","GET"] }
	Addresses []*Address `json:"addresses"`

	// { "description" : "ID of the user who last updated the entity.", "verbs":[] }
	ChangedBy string `json:"changedBy,omitempty"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	CompanyName string `json:"companyName,omitempty"`

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`

	// { "description" : "Date of birth in YYYY-MM-DD format", "verbs":["POST","PUT","GET"] }
	Dob strfmt.DateTime `json:"dob,omitempty"`

	// { "description" : "E-mail address", "verbs":["POST","PUT","GET"] }
	// Required: true
	Email *string `json:"email"`

	// { "description" : "Fax number", "verbs":["POST","PUT","GET"] }
	Fax string `json:"fax,omitempty"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	// Required: true
	FirstName *string `json:"firstName"`

	// { "description" : "ID of the profile.", "verbs":["PUT","GET"] }
	// Required: true
	ID *string `json:"id"`

	// { "description" : "Home telephone number", "verbs":["POST","PUT","GET"] }
	Landline string `json:"landline,omitempty"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	// Required: true
	LastName *string `json:"lastName"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	LogoURL string `json:"logoURL,omitempty"`

	// { "description" : "Mobile telephone number", "verbs":["POST","PUT","GET"] }
	Mobile string `json:"mobile,omitempty"`

	// { "description" : "", "verbs":[] }
	// Required: true
	OrganizationID *string `json:"organizationID"`

	// { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }
	Updated strfmt.DateTime `json:"updated,omitempty"`

	// { "description" : "VAT number", "verbs":["POST","PUT","GET"] }
	VatNumber string `json:"vatNumber,omitempty"`
}

Profile Profile swagger:model Profile

func (*Profile) Validate 

func (m *Profile) Validate(formats strfmt.Registry) error

Validate validates this profile

type ProfilePagedMetadata 

type ProfilePagedMetadata struct {

	// {"description":"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.","verbs":["GET","PUT","POST"]}
	// Required: true
	CurrentOffset *int32 `json:"currentOffset"`

	// {"description":"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.","verbs":["GET","PUT","POST"]}
	// Required: true
	CurrentPage *int32 `json:"currentPage"`

	// {"description":"Number of milliseconds taken by API to calculate response.","verbs":["GET","PUT","POST"]}
	// Required: true
	ExecutionTime *int64 `json:"executionTime"`

	// {"description":"Paging parameter. URL fragment that can be used to fetch next page of results.","verbs":["GET","PUT","POST"]}
	// Required: true
	NextPage *string `json:"nextPage"`

	// {"default":10,"description":"Paging parameter. Describes how many records you requested.","verbs":["GET","PUT","POST"]}
	// Required: true
	RecordsRequested *int32 `json:"recordsRequested"`

	// {"description":"Describes how many records were returned by your query.","verbs":["GET","PUT","POST"]}
	// Required: true
	RecordsReturned *int32 `json:"recordsReturned"`

	// {"description":"The results returned by your query.","verbs":["GET","PUT","POST"]}
	// Required: true
	Results []*Profile `json:"results"`
}

ProfilePagedMetadata profile paged metadata swagger:model ProfilePagedMetadata

func (*ProfilePagedMetadata) Validate 

func (m *ProfilePagedMetadata) Validate(formats strfmt.Registry) error

Validate validates this profile paged metadata

type Receipt 

type Receipt struct {

	// account ID
	AccountID string `json:"accountID,omitempty"`

	// card country
	CardCountry string `json:"cardCountry,omitempty"`

	// card description
	CardDescription string `json:"cardDescription,omitempty"`

	// card last four
	CardLastFour string `json:"cardLastFour,omitempty"`

	// card province
	CardProvince string `json:"cardProvince,omitempty"`

	// card type
	CardType string `json:"cardType,omitempty"`

	// cardholder name
	CardholderName string `json:"cardholderName,omitempty"`

	// { "description" : "ID of the user who last updated the entity.", "verbs":[] }
	ChangedBy string `json:"changedBy,omitempty"`

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`

	// { "description" : "CRM ID of the subscription.", "verbs":["POST","PUT","GET"] }
	// Required: true
	CrmID *string `json:"crmID"`

	// { "description" : "Currency of the invoice specified by a three character ISO 4217 currency code.", "verbs":["POST","PUT","GET"] }
	// Required: true
	Currency *string `json:"currency"`

	// decision
	Decision string `json:"decision,omitempty"`

	// execution attempt
	ExecutionAttempt int32 `json:"executionAttempt,omitempty"`

	// gateway reference ID
	GatewayReferenceID string `json:"gatewayReferenceID,omitempty"`

	// id
	ID string `json:"id,omitempty"`

	// invoice ID
	InvoiceID string `json:"invoiceID,omitempty"`

	// { "description" : "The type of the invoice. A subscription invoice is raised every time a subscription recurs. An amendment is created for intra-contract changes. An Adhoc invoice is created for payment that is taken out-of-band of a subscription. Finally the invoice generated for a trial period is marked as Trial.", "verbs":["POST","PUT","GET"] }
	// Required: true
	InvoiceType *string `json:"invoiceType"`

	// {"description":"IP address associated with this payment method.","verbs":["POST","PUT","GET"]}
	IPAddress string `json:"ipAddress,omitempty"`

	// {"description":"Country of the IP address associated with this payment method.","verbs":["POST","PUT","GET"]}
	IPAddressCountry string `json:"ipAddressCountry,omitempty"`

	// organization ID
	OrganizationID string `json:"organizationID,omitempty"`

	// payment gateway
	PaymentGateway string `json:"paymentGateway,omitempty"`

	// payment ID
	PaymentID string `json:"paymentID,omitempty"`

	// payment method ID
	PaymentMethodID string `json:"paymentMethodID,omitempty"`

	// raw data
	RawData []strfmt.Base64 `json:"rawData"`

	// raw reason code
	RawReasonCode string `json:"rawReasonCode,omitempty"`

	// reason code
	ReasonCode int32 `json:"reasonCode,omitempty"`

	// refund ID
	// Required: true
	RefundID *string `json:"refundID"`

	// { "description" : "Type of transaction.", "verbs":["POST","PUT","GET"] }
	// Required: true
	Type *string `json:"type"`

	// value
	Value float64 `json:"value,omitempty"`
}

Receipt Receipt swagger:model Receipt

func (*Receipt) Validate 

func (m *Receipt) Validate(formats strfmt.Registry) error

Validate validates this receipt

type Refund 

type Refund struct {

	// { "description" : "Identifier of account to refund.", "verbs":["GET"] }
	AccountID string `json:"accountID,omitempty"`

	// { "description" : "Refunded amount", "verbs":[] }
	// Required: true
	ActualRefundedValue *float64 `json:"actualRefundedValue"`

	// { "description" : "", "verbs":[] }
	// Required: true
	ActualValue *float64 `json:"actualValue"`

	// { "description" : "ID of the user who last updated the entity.", "verbs":[] }
	ChangedBy string `json:"changedBy,omitempty"`

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`

	// { "description" : "Refund requested by this account", "verbs":["GET"] }
	CreatedBy string `json:"createdBy,omitempty"`

	// { "description" : "Currency of the refund specified by a three character ISO 4217 currency code.", "verbs":["GET"] }
	// Required: true
	Currency *string `json:"currency"`

	// { "description" : "", "verbs":["GET", "PUT"] }
	ID string `json:"id,omitempty"`

	// { "description" : "Invoice to refund.", "verbs":["POST","GET"] }
	InvoiceID string `json:"invoiceID,omitempty"`

	// { "description" : "Invoice payment to refund", "verbs":["POST", "GET"] }
	InvoicePaymentID string `json:"invoicePaymentID,omitempty"`

	// { "description" : "Nominal value refunded.", "verbs":[] }
	// Required: true
	NominalRefundedValue *float64 `json:"nominalRefundedValue"`

	// { "description" : "", "verbs":[] }
	// Required: true
	NominalValue *float64 `json:"nominalValue"`

	// { "description" : "", "verbs":[] }
	OrganizationID string `json:"organizationID,omitempty"`

	// { "description" : "Reference in the gateway to the payment being refunded.", "verbs":["GET"] }
	OriginalGatewayPaymentReference string `json:"originalGatewayPaymentReference,omitempty"`

	// { "description" : "Original payment being refunded.", "verbs":["GET"] }
	OriginalPaymentID string `json:"originalPaymentID,omitempty"`

	// { "description" : "ID of the receipt for the successful payment that this entity refunds.", "verbs":["POST","GET"] }
	OriginalReceiptID string `json:"originalReceiptID,omitempty"`

	// { "description" : "Payment method to refund from", "verbs":["GET"] }
	PaymentMethodID string `json:"paymentMethodID,omitempty"`

	// { "description" : "The reason for the refund.", "verbs":["GET"] }
	Reason string `json:"reason,omitempty"`

	// { "description" : "ID of the receipt for this refund.", "verbs":["POST","GET"] }
	ReceiptID string `json:"receiptID,omitempty"`

	// { "description" : "When the refund was completed", "verbs":["GET"] }
	RefundCompleted strfmt.DateTime `json:"refundCompleted,omitempty"`

	// { "description" : "", "verbs":[] }
	RefundInvoicePaymentID string `json:"refundInvoicePaymentID,omitempty"`

	// {"default":"<span class=\"label label-default\">SingleAttempt</span>","description":The mechanism by which credit is returned to the customer:<br><span class=\"label label-default\">Void</span> &mdash; The original authorized payment is voided before capture.<br><span class=\"label label-default\">Refund</span> &mdash; A refund is issued against an already-captured payment.","verbs":["GET"]}
	// Required: true
	RefundNature *string `json:"refundNature"`

	// { "description" : "Identifier for the payment used to refund", "verbs":["GET"] }
	RefundPaymentID string `json:"refundPaymentID,omitempty"`

	// { "default" : "AwaitingRefund", "PUT_description" : "<span class=\"label label-default\">Pending</span> refunds can be set to <span class=\"label label-default\">AwaitingRefund</span> to initiate the refund or <span class=\"label label-default\">Cancelled</span> to stop the refund.", "description" : "Initially a refund is in the <span class=\"label label-default\">AwaitingRefund</span> state. Once the funds are successfully returned the state is <span class=\"label label-default\">Refunded</span>. If the refund fails or is rejected is it set as <span class=\"label label-default\">Failed</span>. Refunds can be set to a <span class=\"label label-default\">Pending</span> state to support authorization flows, and will leave the refund pending until updated to <span class=\"label label-default\">AwaitingRefund</span>. <span class=\"label label-default\">Cancelled</span> is when a refund will not be executed.", "verbs":["GET", "POST", "PUT"] }
	// Required: true
	RefundState *string `json:"refundState"`

	// { "description" : "This is the type of refund. Refunds are associated with either an invoice and payment, a payment or unreferenced.", "verbs":[] }
	// Required: true
	RefundType *string `json:"refundType"`

	// { "description" : "Value refunded", "verbs":["GET"] }
	Refunded float64 `json:"refunded,omitempty"`

	// { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }
	Updated strfmt.DateTime `json:"updated,omitempty"`

	// { "description" : "Positive decimal representing the total value to refund. This is at most the amount un-refunded on the payment. If amount is the total payment amount is refunded.", "verbs":["POST","GET"] }
	Value float64 `json:"value,omitempty"`
}

Refund Refund swagger:model Refund

func (*Refund) Validate 

func (m *Refund) Validate(formats strfmt.Registry) error

Validate validates this refund

type ReviveSubscriptionRequest 

type ReviveSubscriptionRequest struct {

	// subscription ID
	// Required: true
	SubscriptionID *string `json:"subscriptionID"`
}

ReviveSubscriptionRequest ReviveSubscriptionRequest swagger:model ReviveSubscriptionRequest

func (*ReviveSubscriptionRequest) Validate 

func (m *ReviveSubscriptionRequest) Validate(formats strfmt.Registry) error

Validate validates this revive subscription request

type StripeAuthCaptureRequest 

type StripeAuthCaptureRequest struct {

	// {"description":"ID of the captured Card in Stripe. This can be provided as well as &mdash; or instead of &mdash; the one-use `stripeToken`, to lead BillForward to the card tokenized within the Stripe vault.","verbs":["POST"]}
	CardID string `json:"cardID,omitempty"`

	// customer ID
	CustomerID string `json:"customerID,omitempty"`

	// {"description":"Single-use token <a href=\"https://stripe.com/docs/stripe.js\">provided by Stripe's client-side card capture SDK</a>, in response to your capturing a card into the Stripe vault. This token will be used by BillForward to find the tokenized card within the Stripe vault &mdash; precursory to linking a BillForward PaymentMethod to that tokenized card.","verbs":["POST"]}
	// Required: true
	StripeToken *string `json:"stripeToken"`
	// contains filtered or unexported fields
}

StripeAuthCaptureRequest stripe auth capture request swagger:model StripeAuthCaptureRequest

func (*StripeAuthCaptureRequest) AccountID 

func (m *StripeAuthCaptureRequest) AccountID() string

func (*StripeAuthCaptureRequest) AtType 

func (m *StripeAuthCaptureRequest) AtType() string

func (*StripeAuthCaptureRequest) CompanyName 

func (m *StripeAuthCaptureRequest) CompanyName() string

func (*StripeAuthCaptureRequest) DefaultPaymentMethod 

func (m *StripeAuthCaptureRequest) DefaultPaymentMethod() *bool

func (*StripeAuthCaptureRequest) Email 

func (m *StripeAuthCaptureRequest) Email() string

func (*StripeAuthCaptureRequest) FirstName 

func (m *StripeAuthCaptureRequest) FirstName() string

func (*StripeAuthCaptureRequest) Gateway 

func (m *StripeAuthCaptureRequest) Gateway() string

func (*StripeAuthCaptureRequest) LastName 

func (m *StripeAuthCaptureRequest) LastName() string

func (StripeAuthCaptureRequest) MarshalJSON 

func (m StripeAuthCaptureRequest) MarshalJSON() ([]byte, error)

MarshalJSON marshals this polymorphic type to a JSON structure

func (*StripeAuthCaptureRequest) Mobile 

func (m *StripeAuthCaptureRequest) Mobile() string

func (*StripeAuthCaptureRequest) OrganizationID 

func (m *StripeAuthCaptureRequest) OrganizationID() string

func (*StripeAuthCaptureRequest) SetAccountID 

func (m *StripeAuthCaptureRequest) SetAccountID(val string)

func (*StripeAuthCaptureRequest) SetAtType 

func (m *StripeAuthCaptureRequest) SetAtType(val string)

func (*StripeAuthCaptureRequest) SetCompanyName 

func (m *StripeAuthCaptureRequest) SetCompanyName(val string)

func (*StripeAuthCaptureRequest) SetDefaultPaymentMethod 

func (m *StripeAuthCaptureRequest) SetDefaultPaymentMethod(val *bool)

func (*StripeAuthCaptureRequest) SetEmail 

func (m *StripeAuthCaptureRequest) SetEmail(val string)

func (*StripeAuthCaptureRequest) SetFirstName 

func (m *StripeAuthCaptureRequest) SetFirstName(val string)

func (*StripeAuthCaptureRequest) SetGateway 

func (m *StripeAuthCaptureRequest) SetGateway(val string)

func (*StripeAuthCaptureRequest) SetLastName 

func (m *StripeAuthCaptureRequest) SetLastName(val string)

func (*StripeAuthCaptureRequest) SetMobile 

func (m *StripeAuthCaptureRequest) SetMobile(val string)

func (*StripeAuthCaptureRequest) SetOrganizationID 

func (m *StripeAuthCaptureRequest) SetOrganizationID(val string)

func (*StripeAuthCaptureRequest) UnmarshalJSON 

func (m *StripeAuthCaptureRequest) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this polymorphic type from a JSON structure

func (*StripeAuthCaptureRequest) Validate 

func (m *StripeAuthCaptureRequest) Validate(formats strfmt.Registry) error

Validate validates this stripe auth capture request

type Subscription 

type Subscription struct {

	// {"description":"","verbs":["POST","GET"]}
	// Required: true
	AccountID *string `json:"accountID"`

	// active
	Active bool `json:"active,omitempty"`

	// {  "default":"true", "description":"Whether the subscription will aggregate all other subscriptions on the account.","verbs":["GET", "PUT", "POST"]}
	AggregateAllSubscriptionsOnAccount *bool `json:"aggregateAllSubscriptionsOnAccount,omitempty"`

	// { "description" : "ID of the user who last updated the entity.", "verbs":[] }
	ChangedBy string `json:"changedBy,omitempty"`

	// {"description":"start of the contracted period.  This will be after a trial, if one exists","verbs":["GET"]}
	ContractStart strfmt.DateTime `json:"contractStart,omitempty"`

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`

	// {  "default":"true", "description":"Can credit-notes be used to pay outstanding invoices for this subscription.","verbs":["GET", "PUT", "POST"]}
	CreditEnabled *bool `json:"creditEnabled,omitempty"`

	// {"description":"","verbs":["POST","PUT","GET"]}
	CrmID string `json:"crmID,omitempty"`

	// {"description":"End of the current period invoiced for. This can be manually updated to extend trials or delay invoice generation.","verbs":["PUT","GET"]}
	CurrentPeriodEnd strfmt.DateTime `json:"currentPeriodEnd,omitempty"`

	// {"description":"Override for the initial subscription period. Allows periods to align to a date or time regardless of purchase date/time.","verbs":["POST","PUT","GET"]}
	CurrentPeriodEndExplicit strfmt.DateTime `json:"currentPeriodEndExplicit,omitempty"`

	// {"description":"Start of the current invoice period. At the end of this period, a new new invoice will be generated","verbs":["POST","GET"]}
	CurrentPeriodStart strfmt.DateTime `json:"currentPeriodStart,omitempty"`

	// {"description":"The current time &mdash; from the point of view of the subscription.","verbs":["GET"]}
	// Required: true
	CurrentTime *strfmt.DateTime `json:"currentTime"`

	// {"description":"","verbs":["POST","PUT","GET"]}
	Description string `json:"description,omitempty"`

	// {  "default":"false", "description":"Are there outstanding invoices which are currently in dunning.","verbs":["GET", "PUT", "POST"]}
	Dunning *bool `json:"dunning,omitempty"`

	// {"default":"None","description":"The action that should be taken, should an invoice for some subscription to this rate plan remain unpaid despite the dunning period's being exceeded.<br><span class=\"label label-default\">CancelSubscription</span> &mdash; Demotes the subscription to the `Failed` state as soon as the dunning period is exceeded.<br><span class=\"label label-default\">None</span> &mdash; The subscription is allowed to continue in the `AwaitingPayment` state indefinitely even if the dunning period is exceeded.For slow payment cycles &mdash; or when manual invoice remediation is common &mdash; <span class=\"label label-default\">None</span> is recommended.<br>In a heavily-automated SaaS environment, automatic cancellation via <span class=\"label label-default\">CancelSubscription</span> is recommended.","verbs":["POST","PUT","GET"]}
	FailedPaymentBehaviour string `json:"failedPaymentBehaviour,omitempty"`

	// {"description":"List of fixed terms that have been or are applied to the subscription","verbs":["GET"]}
	FixedTerms []*FixedTerm `json:"fixedTerms"`

	// {"description":"","verbs":["GET"]}
	// Required: true
	ID *string `json:"id"`

	// {"description":"Start of the first successful period","verbs":["GET"]}
	// Required: true
	InitialPeriodStart *strfmt.DateTime `json:"initialPeriodStart"`

	// {"description":"If the subscription is locked, it will not be processed by the system","verbs":[]}
	Locked string `json:"locked,omitempty"`

	// {"description":"Which system is responsible for managing the subscription.","verbs":[]}
	ManagedBy string `json:"managedBy,omitempty"`

	// { "description" : "Add metadata.", "verbs":["POST"] }
	Metadata DynamicMetadata `json:"metadata,omitempty"`

	// {"description":"User definable friendly name for the subscription.","verbs":["POST","PUT","GET"]}
	// Required: true
	Name *string `json:"name"`

	// {"description":"Organization associated with the subscription.","verbs":[]}
	// Required: true
	OrganizationID *string `json:"organizationID"`

	// {"description":"","verbs":["GET"]}
	ParentID string `json:"parentID,omitempty"`

	// payment method subscription links
	PaymentMethodSubscriptionLinks []*PaymentMethodSubscriptionLink `json:"paymentMethodSubscriptionLinks"`

	// payment terms
	PaymentTerms int64 `json:"paymentTerms,omitempty"`

	// {"description":"The quantities for each pricing component of the rate-plan. Values should be set for all pricing components of the rate-plan apart from the usage components. Usage components should be added when the usage is known, this is often after the end of the current billing cycle.","verbs":["GET", "POST"]}
	PricingComponentValues []*PricingComponentValue `json:"pricingComponentValues"`

	// {"description":"","verbs":["GET"]}
	// Required: true
	ProductID *string `json:"productID"`

	// {"description":"Identifier of the rate-plan being billed for.","verbs":["POST","PUT","GET"]}
	// Required: true
	ProductRatePlanID *string `json:"productRatePlanID"`

	// {"PUT_description":"A <span class=\"label label-default\">Provisioned</span> subscription can be updated to either <span class=\"label label-default\">Trial</span> or <span class=\"label label-default\">AwaitingPayment</span>, this will start the subscription. Any updates to the state of a non-<span class=\"label label-default\">Provisioned</span> will be ignored. To cancel or otherwise amend a subscription please use the explict amendment calls.", "description":"A <span class=\"label label-default\">Provisioned</span> subscription will not begin until marked as <span class=\"label label-default\">Trial</span> or <span class=\"label label-default\">AwaitingPayment</span>. Trial subscriptions transition to <span class=\"label label-default\">AwaitingPayment</span> when the trial period is over. On subscription renewal the state becomes <span class=\"label label-default\">AwaitingPayment</span>. Once outstanding invoices are paid the state changes to <span class=\"label label-default\">Paid</span>. A subscription is set as either <span class=\"label label-default\">Failed</span> or left as <span class=\"label label-default\">AwaitingPayment</span>, depending on the rate-plan configuration. If a subscription is non-recurring or fixed-term and ends naturally, it will be marked as <span class=\"label label-default\">Expired</span>. If all payment attempts have failed a subscription is marked as <span class=\"label label-default\">Cancelled</span> if it has been manually ended. Once a subscription is marked as <span class=\"label label-default\">Failed</span>, <span class=\"label label-default\">Expired</span>, or <span class=\"label label-default\">Cancelled</span> no invoices other than a final invoice will be issued. Note: Updating account card details will not lead to BillForward automatically retrying payment, manual payment attempts can be made.","verbs":["POST","PUT","GET"]}
	// Required: true
	State *string `json:"state"`

	// {"description":"When a subscription will end. This may be in the future if the cancellation is at the end of the current period.","verbs":["GET"]}
	SubscriptionEnd strfmt.DateTime `json:"subscriptionEnd,omitempty"`

	// {"description":"Number of paid-for periods billing, excluding trials, since the subscription started.","verbs":["GET"]}
	SuccessfulPeriods int32 `json:"successfulPeriods,omitempty"`

	// {"description":"How far in the future is the entity (in seconds) compared to the BillForward server's time.","verbs":["GET"]}
	TimeOffset int64 `json:"timeOffset,omitempty"`

	// {"description":"Total number of subscription periods.","verbs":["GET"]}
	TotalPeriods int32 `json:"totalPeriods,omitempty"`

	// {"description":"The end time of the trial period, if one existed","verbs":["GET"]}
	// Required: true
	TrialEnd *strfmt.DateTime `json:"trialEnd"`

	// {"default":"dependent on product", "description":"","verbs":["POST","GET"]}
	Type string `json:"type,omitempty"`

	// { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }
	Updated strfmt.DateTime `json:"updated,omitempty"`

	// {"description":"When the current version of the subscription ended, null indicates current version.","verbs":["GET"]}
	VersionEnd strfmt.DateTime `json:"versionEnd,omitempty"`

	// {"description":"","verbs":["GET"]}
	VersionID string `json:"versionID,omitempty"`

	// {"description":"Incremental version number of the subscription, starts at 1.","verbs":["GET"]}
	// Required: true
	VersionNumber *int32 `json:"versionNumber"`

	// {"description":"When the current version of the subscription started.","verbs":["GET"]}
	// Required: true
	VersionStart *strfmt.DateTime `json:"versionStart"`
}

Subscription Subscription swagger:model Subscription

func (*Subscription) Validate 

func (m *Subscription) Validate(formats strfmt.Registry) error

Validate validates this subscription

type SubscriptionCancellationPagedMetadata 

type SubscriptionCancellationPagedMetadata struct {

	// {"description":"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.","verbs":["GET","PUT","POST"]}
	// Required: true
	CurrentOffset *int32 `json:"currentOffset"`

	// {"description":"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.","verbs":["GET","PUT","POST"]}
	// Required: true
	CurrentPage *int32 `json:"currentPage"`

	// {"description":"Number of milliseconds taken by API to calculate response.","verbs":["GET","PUT","POST"]}
	// Required: true
	ExecutionTime *int64 `json:"executionTime"`

	// {"description":"Paging parameter. URL fragment that can be used to fetch next page of results.","verbs":["GET","PUT","POST"]}
	// Required: true
	NextPage *string `json:"nextPage"`

	// {"default":10,"description":"Paging parameter. Describes how many records you requested.","verbs":["GET","PUT","POST"]}
	// Required: true
	RecordsRequested *int32 `json:"recordsRequested"`

	// {"description":"Describes how many records were returned by your query.","verbs":["GET","PUT","POST"]}
	// Required: true
	RecordsReturned *int32 `json:"recordsReturned"`

	// {"description":"The results returned by your query.","verbs":["GET","PUT","POST"]}
	// Required: true
	Results []*MutableBillingEntity `json:"results"`
}

SubscriptionCancellationPagedMetadata subscription cancellation paged metadata swagger:model SubscriptionCancellationPagedMetadata

func (*SubscriptionCancellationPagedMetadata) Validate 

func (m *SubscriptionCancellationPagedMetadata) Validate(formats strfmt.Registry) error

Validate validates this subscription cancellation paged metadata

type SubscriptionCharge 

type SubscriptionCharge struct {

	// {"description":"ID of the account owning the subscription for which the charge was generated.","verbs":["GET","POST"]}
	AccountID string `json:"accountID,omitempty"`

	// {"description":"Monetary amount of the charge &mdash; including any tax applied to the final amount.","verbs":["POST","GET"]}
	Amount float64 `json:"amount,omitempty"`

	// {"description":"Monetary amount of the charge &mdash; excluding any tax applied to the final amount.","verbs":["GET"]}
	AmountExcludingTax float64 `json:"amountExcludingTax,omitempty"`

	// {"default":"(Empty string)","description":"A human-readable explanation of how the value of the charge was calculated.","verbs":["GET"]}
	Calculation string `json:"calculation,omitempty"`

	// { "description" : "ID of the user who last updated the entity.", "verbs":[] }
	ChangedBy string `json:"changedBy,omitempty"`

	// {"default":"<span class=\"label label-default\">Debit</span>","description":"Whether this charge represents money given to or taken from the customer.<br><span class=\"label label-default\">Credit</span> &mdash; This is a charge for money given to the customer.<br><span class=\"label label-default\">Debit</span> &mdash; This is a charge for money taken from the customer.","verbs":["POST","GET"]}
	// Required: true
	ChargeType *string `json:"chargeType"`

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`

	// {"description":"Customer-relationship-management ID of the charge.","verbs":["GET","PUT","POST"]}
	CrmID string `json:"crmID,omitempty"`

	// { "description" : "Currency of the invoice specified by a three character ISO 4217 currency code.", "verbs":["GET"] }
	Currency string `json:"currency,omitempty"`

	// {"description":"Description given to the charge.","verbs":["POST","GET","PUT"]}
	Description string `json:"description,omitempty"`

	// {"description":"The ID of the charge.","verbs":["GET"]}
	ID string `json:"id,omitempty"`

	// {"description":"ID of the invoice to which this charge applies (if the charge targets a specific invoice).","verbs":["POST","GET"]}
	InvoiceID string `json:"invoiceID,omitempty"`

	// {"default":"<span class=\"label label-default\">Aggregated</span>","description":"The strategy for how this charge will raise invoices.<br><span class=\"label label-default\">Immediate</span> &mdash; Generate straight-away an invoice containing this charge.<br><span class=\"label label-default\">Aggregated</span> &mdash; Add this charge to the next invoice which is generated naturally &mdash; i.e. the invoice raised at the current period's end.","verbs":["POST","GET"]}
	// Required: true
	InvoicingType *string `json:"invoicingType"`

	// {"description":"Friendly name given to the charge to help identify it.","verbs":["POST","GET","PUT"]}
	Name string `json:"name,omitempty"`

	// {"default":"(End of current period)","description":"The time-ending of the interval to which the charge applies. This can be used to apply a charge across partial or multiple periods,to pro-rate its price.","verbs":["POST","GET"]}
	PeriodEnd strfmt.DateTime `json:"periodEnd,omitempty"`

	// {"default":"(Now)","description":"The time-beginning of the interval to which the charge applies. This can be used to apply a charge across partial or multiple periods,to pro-rate its price.","verbs":["POST","GET"]}
	PeriodStart strfmt.DateTime `json:"periodStart,omitempty"`

	// {"default":"<span class=\"label label-default\">Rollover</span>","description":"Defines the behaviour applied to any outstanding credit resulting from the application of the charge..<br><span class=\"label label-default\">Rollover</span> &mdash; Outstanding credit is returned to the accounts credit pool.<br><span class=\"label label-default\">Discard</span> &mdash; Outstanding credit is lost.","verbs":["POST","GET"]}
	// Required: true
	RemainingCreditBehaviour *string `json:"remainingCreditBehaviour"`

	// {"default":"<span class=\"label label-default\">Pending</span>","description":"The current state of the charge.","verbs":["POST","GET","PUT"]}
	// Required: true
	State *string `json:"state"`

	// {"description":"ID of the subscription for which the charge was generated.","verbs":["GET","POST"]}
	SubscriptionID string `json:"subscriptionID,omitempty"`

	// {"description":"Version ID of the subscription for which the charge was generated.","verbs":["GET","POST"]}
	SubscriptionVersionID string `json:"subscriptionVersionID,omitempty"`

	// {"default":"false","description":"(Applicable only if any of [`pricingComponentName`, `pricingComponentID`] are defined)<br>Whether the charge was created for a subscription whilst in a trial period.<br><span class=\"label label-default\">false</span> &mdash; This is a non-trial charge, so funds will be sought from the customer.<br><span class=\"label label-default\">true</span> &mdash; This is a trial charge, soThe charge can be considered 'Paid' without taking any funds from the customer.","verbs":["POST","GET"]}
	Trial *bool `json:"trial,omitempty"`

	// {"description":"A type describing the nature of the charge.","verbs":["POST","GET"]}
	// Required: true
	Type *string `json:"type"`

	// { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }
	Updated strfmt.DateTime `json:"updated,omitempty"`

	// {"description":"The version ID of the charge.","verbs":["GET"]}
	VersionID string `json:"versionID,omitempty"`

	// {"description":"The version number of the charge. The first version of a charge is version number 1.","verbs":["GET"]}
	// Required: true
	VersionNumber *int32 `json:"versionNumber"`
}

SubscriptionCharge Represents a monetary amount &mdash; or quantity consumed &mdash; attributed to some invoice or subscription. swagger:model SubscriptionCharge

func (*SubscriptionCharge) Validate 

func (m *SubscriptionCharge) Validate(formats strfmt.Registry) error

Validate validates this subscription charge

type SubscriptionPagedMetadata 

type SubscriptionPagedMetadata struct {

	// {"description":"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.","verbs":["GET","PUT","POST"]}
	// Required: true
	CurrentOffset *int32 `json:"currentOffset"`

	// {"description":"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.","verbs":["GET","PUT","POST"]}
	// Required: true
	CurrentPage *int32 `json:"currentPage"`

	// {"description":"Number of milliseconds taken by API to calculate response.","verbs":["GET","PUT","POST"]}
	// Required: true
	ExecutionTime *int64 `json:"executionTime"`

	// {"description":"Paging parameter. URL fragment that can be used to fetch next page of results.","verbs":["GET","PUT","POST"]}
	// Required: true
	NextPage *string `json:"nextPage"`

	// {"default":10,"description":"Paging parameter. Describes how many records you requested.","verbs":["GET","PUT","POST"]}
	// Required: true
	RecordsRequested *int32 `json:"recordsRequested"`

	// {"description":"Describes how many records were returned by your query.","verbs":["GET","PUT","POST"]}
	// Required: true
	RecordsReturned *int32 `json:"recordsReturned"`

	// {"description":"The results returned by your query.","verbs":["GET","PUT","POST"]}
	// Required: true
	Results []*Subscription `json:"results"`
}

SubscriptionPagedMetadata subscription paged metadata swagger:model SubscriptionPagedMetadata

func (*SubscriptionPagedMetadata) Validate 

func (m *SubscriptionPagedMetadata) Validate(formats strfmt.Registry) error

Validate validates this subscription paged metadata

type TieredPricingComponent 

type TieredPricingComponent struct {
	// contains filtered or unexported fields
}

TieredPricingComponent tiered pricing component swagger:model tieredPricingComponent

func (*TieredPricingComponent) AtType 

func (m *TieredPricingComponent) AtType() string

func (*TieredPricingComponent) ChangedBy 

func (m *TieredPricingComponent) ChangedBy() string

func (*TieredPricingComponent) ChargeModel 

func (m *TieredPricingComponent) ChargeModel() *string

func (*TieredPricingComponent) ChargeType 

func (m *TieredPricingComponent) ChargeType() *string

func (*TieredPricingComponent) Created 

func (m *TieredPricingComponent) Created() strfmt.DateTime

func (*TieredPricingComponent) CrmID 

func (m *TieredPricingComponent) CrmID() string

func (*TieredPricingComponent) DefaultQuantity 

func (m *TieredPricingComponent) DefaultQuantity() *int32

func (*TieredPricingComponent) Description 

func (m *TieredPricingComponent) Description() string

func (*TieredPricingComponent) DowngradeMode 

func (m *TieredPricingComponent) DowngradeMode() string

func (*TieredPricingComponent) ID 

func (m *TieredPricingComponent) ID() *string

func (*TieredPricingComponent) InvoicingType 

func (m *TieredPricingComponent) InvoicingType() string

func (TieredPricingComponent) MarshalJSON 

func (m TieredPricingComponent) MarshalJSON() ([]byte, error)

MarshalJSON marshals this polymorphic type to a JSON structure

func (*TieredPricingComponent) MaxQuantity 

func (m *TieredPricingComponent) MaxQuantity() int32

func (*TieredPricingComponent) MinQuantity 

func (m *TieredPricingComponent) MinQuantity() int32

func (*TieredPricingComponent) Name 

func (m *TieredPricingComponent) Name() *string

func (*TieredPricingComponent) OrganizationID 

func (m *TieredPricingComponent) OrganizationID() *string

func (*TieredPricingComponent) ProductRatePlanID 

func (m *TieredPricingComponent) ProductRatePlanID() *string

func (*TieredPricingComponent) PublicName 

func (m *TieredPricingComponent) PublicName() string

func (*TieredPricingComponent) SetAtType 

func (m *TieredPricingComponent) SetAtType(val string)

func (*TieredPricingComponent) SetChangedBy 

func (m *TieredPricingComponent) SetChangedBy(val string)

func (*TieredPricingComponent) SetChargeModel 

func (m *TieredPricingComponent) SetChargeModel(val *string)

func (*TieredPricingComponent) SetChargeType 

func (m *TieredPricingComponent) SetChargeType(val *string)

func (*TieredPricingComponent) SetCreated 

func (m *TieredPricingComponent) SetCreated(val strfmt.DateTime)

func (*TieredPricingComponent) SetCrmID 

func (m *TieredPricingComponent) SetCrmID(val string)

func (*TieredPricingComponent) SetDefaultQuantity 

func (m *TieredPricingComponent) SetDefaultQuantity(val *int32)

func (*TieredPricingComponent) SetDescription 

func (m *TieredPricingComponent) SetDescription(val string)

func (*TieredPricingComponent) SetDowngradeMode 

func (m *TieredPricingComponent) SetDowngradeMode(val string)

func (*TieredPricingComponent) SetID 

func (m *TieredPricingComponent) SetID(val *string)

func (*TieredPricingComponent) SetInvoicingType 

func (m *TieredPricingComponent) SetInvoicingType(val string)

func (*TieredPricingComponent) SetMaxQuantity 

func (m *TieredPricingComponent) SetMaxQuantity(val int32)

func (*TieredPricingComponent) SetMinQuantity 

func (m *TieredPricingComponent) SetMinQuantity(val int32)

func (*TieredPricingComponent) SetName 

func (m *TieredPricingComponent) SetName(val *string)

func (*TieredPricingComponent) SetOrganizationID 

func (m *TieredPricingComponent) SetOrganizationID(val *string)

func (*TieredPricingComponent) SetProductRatePlanID 

func (m *TieredPricingComponent) SetProductRatePlanID(val *string)

func (*TieredPricingComponent) SetPublicName 

func (m *TieredPricingComponent) SetPublicName(val string)

func (*TieredPricingComponent) SetTiers 

func (m *TieredPricingComponent) SetTiers(val []*PricingComponentTier)

func (*TieredPricingComponent) SetUnitOfMeasure 

func (m *TieredPricingComponent) SetUnitOfMeasure(val *UnitOfMeasure)

func (*TieredPricingComponent) SetUnitOfMeasureID 

func (m *TieredPricingComponent) SetUnitOfMeasureID(val *string)

func (*TieredPricingComponent) SetUpdated 

func (m *TieredPricingComponent) SetUpdated(val strfmt.DateTime)

func (*TieredPricingComponent) SetUpgradeMode 

func (m *TieredPricingComponent) SetUpgradeMode(val string)

func (*TieredPricingComponent) SetValidFrom 

func (m *TieredPricingComponent) SetValidFrom(val *strfmt.DateTime)

func (*TieredPricingComponent) SetValidTill 

func (m *TieredPricingComponent) SetValidTill(val *strfmt.DateTime)

func (*TieredPricingComponent) SetVersionID 

func (m *TieredPricingComponent) SetVersionID(val *string)

func (*TieredPricingComponent) Tiers 

func (m *TieredPricingComponent) Tiers() []*PricingComponentTier

func (*TieredPricingComponent) UnitOfMeasure 

func (m *TieredPricingComponent) UnitOfMeasure() *UnitOfMeasure

func (*TieredPricingComponent) UnitOfMeasureID 

func (m *TieredPricingComponent) UnitOfMeasureID() *string

func (*TieredPricingComponent) UnmarshalJSON 

func (m *TieredPricingComponent) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this polymorphic type from a JSON structure

func (*TieredPricingComponent) Updated 

func (m *TieredPricingComponent) Updated() strfmt.DateTime

func (*TieredPricingComponent) UpgradeMode 

func (m *TieredPricingComponent) UpgradeMode() string

func (*TieredPricingComponent) ValidFrom 

func (m *TieredPricingComponent) ValidFrom() *strfmt.DateTime

func (*TieredPricingComponent) ValidTill 

func (m *TieredPricingComponent) ValidTill() *strfmt.DateTime

func (*TieredPricingComponent) Validate 

func (m *TieredPricingComponent) Validate(formats strfmt.Registry) error

Validate validates this tiered pricing component

func (*TieredPricingComponent) VersionID 

func (m *TieredPricingComponent) VersionID() *string

type TieredVolumePricingComponent 

type TieredVolumePricingComponent struct {
	// contains filtered or unexported fields
}

TieredVolumePricingComponent tiered volume pricing component swagger:model tieredVolumePricingComponent

func (*TieredVolumePricingComponent) AtType 

func (m *TieredVolumePricingComponent) AtType() string

func (*TieredVolumePricingComponent) ChangedBy 

func (m *TieredVolumePricingComponent) ChangedBy() string

func (*TieredVolumePricingComponent) ChargeModel 

func (m *TieredVolumePricingComponent) ChargeModel() *string

func (*TieredVolumePricingComponent) ChargeType 

func (m *TieredVolumePricingComponent) ChargeType() *string

func (*TieredVolumePricingComponent) Created 

func (m *TieredVolumePricingComponent) Created() strfmt.DateTime

func (*TieredVolumePricingComponent) CrmID 

func (m *TieredVolumePricingComponent) CrmID() string

func (*TieredVolumePricingComponent) DefaultQuantity 

func (m *TieredVolumePricingComponent) DefaultQuantity() *int32

func (*TieredVolumePricingComponent) Description 

func (m *TieredVolumePricingComponent) Description() string

func (*TieredVolumePricingComponent) DowngradeMode 

func (m *TieredVolumePricingComponent) DowngradeMode() string

func (*TieredVolumePricingComponent) ID 

func (m *TieredVolumePricingComponent) ID() *string

func (*TieredVolumePricingComponent) InvoicingType 

func (m *TieredVolumePricingComponent) InvoicingType() string

func (TieredVolumePricingComponent) MarshalJSON 

func (m TieredVolumePricingComponent) MarshalJSON() ([]byte, error)

MarshalJSON marshals this polymorphic type to a JSON structure

func (*TieredVolumePricingComponent) MaxQuantity 

func (m *TieredVolumePricingComponent) MaxQuantity() int32

func (*TieredVolumePricingComponent) MinQuantity 

func (m *TieredVolumePricingComponent) MinQuantity() int32

func (*TieredVolumePricingComponent) Name 

func (m *TieredVolumePricingComponent) Name() *string

func (*TieredVolumePricingComponent) OrganizationID 

func (m *TieredVolumePricingComponent) OrganizationID() *string

func (*TieredVolumePricingComponent) ProductRatePlanID 

func (m *TieredVolumePricingComponent) ProductRatePlanID() *string

func (*TieredVolumePricingComponent) PublicName 

func (m *TieredVolumePricingComponent) PublicName() string

func (*TieredVolumePricingComponent) SetAtType 

func (m *TieredVolumePricingComponent) SetAtType(val string)

func (*TieredVolumePricingComponent) SetChangedBy 

func (m *TieredVolumePricingComponent) SetChangedBy(val string)

func (*TieredVolumePricingComponent) SetChargeModel 

func (m *TieredVolumePricingComponent) SetChargeModel(val *string)

func (*TieredVolumePricingComponent) SetChargeType 

func (m *TieredVolumePricingComponent) SetChargeType(val *string)

func (*TieredVolumePricingComponent) SetCreated 

func (m *TieredVolumePricingComponent) SetCreated(val strfmt.DateTime)

func (*TieredVolumePricingComponent) SetCrmID 

func (m *TieredVolumePricingComponent) SetCrmID(val string)

func (*TieredVolumePricingComponent) SetDefaultQuantity 

func (m *TieredVolumePricingComponent) SetDefaultQuantity(val *int32)

func (*TieredVolumePricingComponent) SetDescription 

func (m *TieredVolumePricingComponent) SetDescription(val string)

func (*TieredVolumePricingComponent) SetDowngradeMode 

func (m *TieredVolumePricingComponent) SetDowngradeMode(val string)

func (*TieredVolumePricingComponent) SetID 

func (m *TieredVolumePricingComponent) SetID(val *string)

func (*TieredVolumePricingComponent) SetInvoicingType 

func (m *TieredVolumePricingComponent) SetInvoicingType(val string)

func (*TieredVolumePricingComponent) SetMaxQuantity 

func (m *TieredVolumePricingComponent) SetMaxQuantity(val int32)

func (*TieredVolumePricingComponent) SetMinQuantity 

func (m *TieredVolumePricingComponent) SetMinQuantity(val int32)

func (*TieredVolumePricingComponent) SetName 

func (m *TieredVolumePricingComponent) SetName(val *string)

func (*TieredVolumePricingComponent) SetOrganizationID 

func (m *TieredVolumePricingComponent) SetOrganizationID(val *string)

func (*TieredVolumePricingComponent) SetProductRatePlanID 

func (m *TieredVolumePricingComponent) SetProductRatePlanID(val *string)

func (*TieredVolumePricingComponent) SetPublicName 

func (m *TieredVolumePricingComponent) SetPublicName(val string)

func (*TieredVolumePricingComponent) SetTiers 

func (m *TieredVolumePricingComponent) SetTiers(val []*PricingComponentTier)

func (*TieredVolumePricingComponent) SetUnitOfMeasure 

func (m *TieredVolumePricingComponent) SetUnitOfMeasure(val *UnitOfMeasure)

func (*TieredVolumePricingComponent) SetUnitOfMeasureID 

func (m *TieredVolumePricingComponent) SetUnitOfMeasureID(val *string)

func (*TieredVolumePricingComponent) SetUpdated 

func (m *TieredVolumePricingComponent) SetUpdated(val strfmt.DateTime)

func (*TieredVolumePricingComponent) SetUpgradeMode 

func (m *TieredVolumePricingComponent) SetUpgradeMode(val string)

func (*TieredVolumePricingComponent) SetValidFrom 

func (m *TieredVolumePricingComponent) SetValidFrom(val *strfmt.DateTime)

func (*TieredVolumePricingComponent) SetValidTill 

func (m *TieredVolumePricingComponent) SetValidTill(val *strfmt.DateTime)

func (*TieredVolumePricingComponent) SetVersionID 

func (m *TieredVolumePricingComponent) SetVersionID(val *string)

func (*TieredVolumePricingComponent) Tiers 

func (m *TieredVolumePricingComponent) Tiers() []*PricingComponentTier

func (*TieredVolumePricingComponent) UnitOfMeasure 

func (m *TieredVolumePricingComponent) UnitOfMeasure() *UnitOfMeasure

func (*TieredVolumePricingComponent) UnitOfMeasureID 

func (m *TieredVolumePricingComponent) UnitOfMeasureID() *string

func (*TieredVolumePricingComponent) UnmarshalJSON 

func (m *TieredVolumePricingComponent) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this polymorphic type from a JSON structure

func (*TieredVolumePricingComponent) Updated 

func (m *TieredVolumePricingComponent) Updated() strfmt.DateTime

func (*TieredVolumePricingComponent) UpgradeMode 

func (m *TieredVolumePricingComponent) UpgradeMode() string

func (*TieredVolumePricingComponent) ValidFrom 

func (m *TieredVolumePricingComponent) ValidFrom() *strfmt.DateTime

func (*TieredVolumePricingComponent) ValidTill 

func (m *TieredVolumePricingComponent) ValidTill() *strfmt.DateTime

func (*TieredVolumePricingComponent) Validate 

func (m *TieredVolumePricingComponent) Validate(formats strfmt.Registry) error

Validate validates this tiered volume pricing component

func (*TieredVolumePricingComponent) VersionID 

func (m *TieredVolumePricingComponent) VersionID() *string

type TimeRequest 

type TimeRequest struct {

	// {"default":true,"description":"When advancing onto an instant in time:<br><span class=\"label label-default\">true</span> &mdash; Action the events scheduled for your destination time. Amendments scheduled at your destined time will be actioned during this time travel. Advancing to a period boundary will promote your subscription to the period on the future side of that boundary.<br><span class=\"label label-default\">false</span> &mdash; Do not action events scheduled for your destination time. Amendments scheduled at your destined time will not be actioned during this time travel. Advancing to a period boundary will result in your subscription's remaining within the period on the past side of that boundary.","verbs":["POST","GET"]}
	AdvanceInclusively *bool `json:"advanceInclusively,omitempty"`

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created *strfmt.DateTime `json:"created,omitempty"`

	// {"default":false,"description":"Changes described in the response:<br><span class=\"label label-default\">true</span> &mdash; Are not actually performed; your subscription remains unchanged, no billing events run, and no invoices are executed.<br><span class=\"label label-default\">false</span> &mdash; Are actually performed and committed.","verbs":["POST","GET"]}
	DryRun *bool `json:"dryRun,omitempty"`

	// {"default":"<span class=\"label label-default\">SingleAttempt</span>","description":"What strategy to use when executing any invoices raised as time advances:<br><span class=\"label label-default\">SingleAttempt</span> &mdash; Execute any invoice just once.<br><span class=\"label label-default\">FollowDunning</span> &mdash; Apply the existing dunning strategy when executing invoices.<br><span class=\"label label-default\">None</span>: Do not execute invoices.","verbs":["POST","GET"]}
	ExecutionStrategy string `json:"executionStrategy,omitempty"`

	// {"default":false,"description":"Once the subscription is advanced through time:<br><span class=\"label label-default\">true</span> &mdash; Freeze the subscription.<br><span class=\"label label-default\">false</span> &mdash; Do not freeze the subscription.","verbs":["POST","GET"]}
	FreezeOnCompletion *bool `json:"freezeOnCompletion,omitempty"`

	// {"default":true,"description":"As time scrubs forward:<br><span class=\"label label-default\">true</span> &mdash; Run any amendments that were scheduled to action.<br><span class=\"label label-default\">false</span> &mdash; Do not run any amendments that were scheduled to action.","verbs":["POST","GET"]}
	HandleAmendments *bool `json:"handleAmendments,omitempty"`

	// {"description":"(Required: one of [`periods`, `to`])<br>The number of period boundaries up to which the subscription should advance.
	// A 1-value advances the subscription to the end of its current service period.
	// Higher values advance the subscription to subsequent period boundaries."verbs":["POST","GET"]}
	Periods *int32 `json:"periods,omitempty"`

	// {"default":false,"description":"As time scrubs forward:<br><span class=\"label label-default\">true</span> &mdash; Raise no invoice upon advancing over a period boundary.<br><span class=\"label label-default\">false</span> &mdash; Raise invoices for any period that is entered.","verbs":["POST","GET"]}
	SkipIntermediatePeriods *bool `json:"skipIntermediatePeriods,omitempty"`

	// {"description":"(Required: one of [`periods`, `to`])<br>The time up until which the subscription should be fast-forwarded.","verbs":["POST","GET"]}
	To *strfmt.DateTime `json:"to,omitempty"`
}

TimeRequest Request object for advancing a subscription's flow through time. swagger:model TimeRequest

func (*TimeRequest) Validate 

func (m *TimeRequest) Validate(formats strfmt.Registry) error

Validate validates this time request

type TimeResponse 

type TimeResponse struct {

	// {"default":true,"description":"When advancing onto an instant in time:<br><span class=\"label label-default\">true</span> &mdash; Action the events scheduled for your destination time. Amendments scheduled at your destined time will be actioned during this time travel. Advancing to a period boundary will promote your subscription to the period on the future side of that boundary.<br><span class=\"label label-default\">false</span> &mdash; Do not action events scheduled for your destination time. Amendments scheduled at your destined time will not be actioned during this time travel. Advancing to a period boundary will result in your subscription's remaining within the period on the past side of that boundary.","verbs":["POST","GET"]}
	AdvanceInclusively *bool `json:"advanceInclusively,omitempty"`

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`

	// {"default":false,"description":"Changes described in the response:<br><span class=\"label label-default\">true</span> &mdash; Are not actually performed; your subscription remains unchanged, no billing events run, and no invoices are executed.<br><span class=\"label label-default\">false</span> &mdash; Are actually performed and committed.","verbs":["POST","GET"]}
	DryRun *bool `json:"dryRun,omitempty"`

	// {"default":"<span class=\"label label-default\">SingleAttempt</span>","description":"What strategy to use when executing any invoices raised as time advances:<br><span class=\"label label-default\">SingleAttempt</span> &mdash; Execute any invoice just once.<br><span class=\"label label-default\">FollowDunning</span> &mdash; Apply the existing dunning strategy when executing invoices.<br><span class=\"label label-default\">None</span>: Do not execute invoices.","verbs":["POST","GET"]}
	ExecutionStrategy string `json:"executionStrategy,omitempty"`

	// {"default":false,"description":"Once the subscription is advanced through time:<br><span class=\"label label-default\">true</span> &mdash; Freeze the subscription.<br><span class=\"label label-default\">false</span> &mdash; Do not freeze the subscription.","verbs":["POST","GET"]}
	FreezeOnCompletion *bool `json:"freezeOnCompletion,omitempty"`

	// {"default":true,"description":"As time scrubs forward:<br><span class=\"label label-default\">true</span> &mdash; Run any amendments that were scheduled to action.<br><span class=\"label label-default\">false</span> &mdash; Do not run any amendments that were scheduled to action.","verbs":["POST","GET"]}
	HandleAmendments *bool `json:"handleAmendments,omitempty"`

	// invoices
	Invoices []*Invoice `json:"invoices"`

	// {"description":"(Required: one of [`periods`, `to`])<br>The number of period boundaries up to which the subscription should advance.
	// A 1-value advances the subscription to the end of its current service period.
	// Higher values advance the subscription to subsequent period boundaries."verbs":["POST","GET"]}
	Periods int32 `json:"periods,omitempty"`

	// {"default":false,"description":"As time scrubs forward:<br><span class=\"label label-default\">true</span> &mdash; Raise no invoice upon advancing over a period boundary.<br><span class=\"label label-default\">false</span> &mdash; Raise invoices for any period that is entered.","verbs":["POST","GET"]}
	SkipIntermediatePeriods *bool `json:"skipIntermediatePeriods,omitempty"`

	// subscriptions
	Subscriptions []*Subscription `json:"subscriptions"`

	// {"description":"(Required: one of [`periods`, `to`])<br>The time up until which the subscription should be fast-forwarded.","verbs":["POST","GET"]}
	To strfmt.DateTime `json:"to,omitempty"`
}

TimeResponse Response object returned upon advancing a subscription's flow through time. swagger:model TimeResponse

func (*TimeResponse) Validate 

func (m *TimeResponse) Validate(formats strfmt.Registry) error

Validate validates this time response

type TimeResponsePagedMetadata 

type TimeResponsePagedMetadata struct {

	// {"description":"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.","verbs":["GET","PUT","POST"]}
	// Required: true
	CurrentOffset *int32 `json:"currentOffset"`

	// {"description":"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.","verbs":["GET","PUT","POST"]}
	// Required: true
	CurrentPage *int32 `json:"currentPage"`

	// {"description":"Number of milliseconds taken by API to calculate response.","verbs":["GET","PUT","POST"]}
	// Required: true
	ExecutionTime *int64 `json:"executionTime"`

	// {"description":"Paging parameter. URL fragment that can be used to fetch next page of results.","verbs":["GET","PUT","POST"]}
	// Required: true
	NextPage *string `json:"nextPage"`

	// {"default":10,"description":"Paging parameter. Describes how many records you requested.","verbs":["GET","PUT","POST"]}
	// Required: true
	RecordsRequested *int32 `json:"recordsRequested"`

	// {"description":"Describes how many records were returned by your query.","verbs":["GET","PUT","POST"]}
	// Required: true
	RecordsReturned *int32 `json:"recordsReturned"`

	// {"description":"The results returned by your query.","verbs":["GET","PUT","POST"]}
	// Required: true
	Results []*TimeResponse `json:"results"`
}

TimeResponsePagedMetadata time response paged metadata swagger:model TimeResponsePagedMetadata

func (*TimeResponsePagedMetadata) Validate 

func (m *TimeResponsePagedMetadata) Validate(formats strfmt.Registry) error

Validate validates this time response paged metadata

type UnitOfMeasure 

type UnitOfMeasure struct {

	// { "description" : "ID of the user who last updated the entity.", "verbs":[] }
	ChangedBy string `json:"changedBy,omitempty"`

	// { "description" : "The UTC DateTime when the object was created.", "verbs":[] }
	Created strfmt.DateTime `json:"created,omitempty"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	CrmID string `json:"crmID,omitempty"`

	// { "description" : "", "verbs":["GET"] }
	// Required: true
	Deleted bool `json:"deleted"`

	// { "description" : "Unit of measurement, such as users, pounds, minutes.", "verbs":["POST","PUT","GET"] }
	// Required: true
	DisplayedAs *string `json:"displayedAs"`

	// { "description" : "", "verbs":["GET"] }
	ID string `json:"id,omitempty"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	// Required: true
	Name *string `json:"name"`

	// { "description" : "", "verbs":[] }
	// Required: true
	OrganizationID *string `json:"organizationID"`

	// { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }
	Updated strfmt.DateTime `json:"updated,omitempty"`
}

UnitOfMeasure Units in which a "quantity of consumed PricingComponent" can be measured swagger:model UnitOfMeasure

func (*UnitOfMeasure) Validate 

func (m *UnitOfMeasure) Validate(formats strfmt.Registry) error

Validate validates this unit of measure

type UpdateAddressRequest 

type UpdateAddressRequest struct {

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	AddressLine1 string `json:"addressLine1,omitempty"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	AddressLine2 string `json:"addressLine2,omitempty"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	AddressLine3 string `json:"addressLine3,omitempty"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	City string `json:"city,omitempty"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	Country string `json:"country,omitempty"`

	// id
	// Required: true
	ID *string `json:"id"`

	// { "description" : "Phone number", "verbs":["POST","PUT","GET"] }
	Landline string `json:"landline,omitempty"`

	// { "description" : "ZIP code or postcode.", "verbs":["POST","PUT","GET"] }
	Postcode string `json:"postcode,omitempty"`

	// { "description" : "Is this the primary, default, address for the associated profile?", "verbs":["POST","PUT","GET"] }
	PrimaryAddress *bool `json:"primaryAddress,omitempty"`

	// { "description" : "", "verbs":["GET"] }
	// Required: true
	ProfileID *string `json:"profileID"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	Province string `json:"province,omitempty"`
}

UpdateAddressRequest CreateAddressRequest swagger:model UpdateAddressRequest

func (*UpdateAddressRequest) Validate 

func (m *UpdateAddressRequest) Validate(formats strfmt.Registry) error

Validate validates this update address request

type UpdateProfileRequest 

type UpdateProfileRequest struct {

	// { "description" : "", "verbs":["GET"] }
	// Required: true
	AccountID *string `json:"accountID"`

	// { "description" : "Any additional information", "verbs":["POST","PUT","GET"] }
	AdditionalInformation *string `json:"additionalInformation,omitempty"`

	// { "description" : "Address associated with the profile", "verbs":["POST","PUT","GET"] }
	Addresses []*Address `json:"addresses"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	CompanyName *string `json:"companyName,omitempty"`

	// { "description" : "Date of birth in YYYY-MM-DD format", "verbs":["POST","PUT","GET"] }
	Dob *strfmt.DateTime `json:"dob,omitempty"`

	// { "description" : "E-mail address", "verbs":["POST","PUT","GET"] }
	Email *string `json:"email,omitempty"`

	// { "description" : "Fax number", "verbs":["POST","PUT","GET"] }
	Fax *string `json:"fax,omitempty"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	FirstName *string `json:"firstName,omitempty"`

	// id
	ID string `json:"id,omitempty"`

	// { "description" : "Home telephone number", "verbs":["POST","PUT","GET"] }
	Landline *string `json:"landline,omitempty"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	LastName *string `json:"lastName,omitempty"`

	// { "description" : "", "verbs":["POST","PUT","GET"] }
	LogoURL *string `json:"logoURL,omitempty"`

	// { "description" : "Mobile telephone number", "verbs":["POST","PUT","GET"] }
	Mobile *string `json:"mobile,omitempty"`

	// { "description" : "", "verbs":[] }
	OrganizationID *string `json:"organizationID,omitempty"`

	// { "description" : "VAT number", "verbs":["POST","PUT","GET"] }
	VatNumber *string `json:"vatNumber,omitempty"`
}

UpdateProfileRequest UpdateProfileRequest swagger:model UpdateProfileRequest

func (*UpdateProfileRequest) Validate 

func (m *UpdateProfileRequest) Validate(formats strfmt.Registry) error

Validate validates this update profile request

type UpdateSubscriptionRequest 

type UpdateSubscriptionRequest struct {

	// {"description":"Whether this subscription should become an 'aggregating subscription', collecting charges (starting now) from all other subscriptions (current and future) belonging to this BillForward Account.","verbs":["POST"]}
	AggregateAllSubscriptionsOnAccount *bool `json:"aggregateAllSubscriptionsOnAccount,omitempty"`

	// {"default":true,"description":"Whether to override the `end` date to line up with the current period end of the 'aggregating subscription' to which this subscription belongs.","verbs":["POST"]}
	AlignPeriodWithAggregatingSubscription *bool `json:"alignPeriodWithAggregatingSubscription,omitempty"`

	// {"description":"New description to assign to the updated subscription. This is primarily for your benefit &mdash; for example, you could write here the mechanism through which you obtained this customer. (e.g. 'Customer obtained through Lazy Wednesdays promotion').","verbs":["POST"]}
	Description string `json:"description,omitempty"`

	// {"description":"[Can only be changed if subscription is still in Provisioned state] ISO 8601 UTC DateTime (e.g. 2015-06-16T11:58:41Z) describing the date at which the subscription should finish its first service period.","verbs":["POST"]}
	End *strfmt.DateTime `json:"end,omitempty"`

	// {"default":"None","description":"The action that should be taken, should an invoice for some subscription to this rate plan remain unpaid despite the dunning period's being exceeded.<br><span class=\"label label-default\">CancelSubscription</span> &mdash; Demotes the subscription to the `Failed` state as soon as the dunning period is exceeded.<br><span class=\"label label-default\">None</span> &mdash; The subscription is allowed to continue in the `AwaitingPayment` state indefinitely even if the dunning period is exceeded.For slow payment cycles &mdash; or when manual invoice remediation is common &mdash; <span class=\"label label-default\">None</span> is recommended.<br>In a heavily-automated SaaS environment, automatic cancellation via <span class=\"label label-default\">CancelSubscription</span> is recommended.","verbs":["POST","PUT","GET"]}
	FailedPaymentBehaviour string `json:"failedPaymentBehaviour,omitempty"`

	// {"description":"ID of the Subscription you wish to update.","verbs":["POST"]}
	// Required: true
	ID *string `json:"id"`

	// {"description":"New name to assign to the updated subscription. This is primarily for your benefit &mdash; for example, to enable you to identify subscriptions at a glance in the BillForward web interface (e.g. 'Customer 1425, guy@mail.com, Premium membership').","verbs":["POST"]}
	Name string `json:"name,omitempty"`

	// {"description":"ID of a parent subscription which will collect the charges raised by this subscription. The parent becomes responsible for paying those charges.","verbs":["POST"]}
	ParentID string `json:"parentID,omitempty"`

	// {"description":"[Can only be changed if subscription is still in Provisioned state] ISO 8601 UTC DateTime (e.g. 2015-06-16T11:58:41Z) describing the date at which the subscription should enter its first service period.","verbs":["POST"]}
	Start *strfmt.DateTime `json:"start,omitempty"`

	// {"description":"[Can only be changed if subscription is still in Provisioned state] The state into which you wish to move the updated subscription.<br><span class=\"label label-default\">AwaitingPayment</span> &mdash; The subscription is activated. After `start` time is surpassed, it will begin service and raise its first invoice.","verbs":["POST"]}
	State string `json:"state,omitempty"`
}

UpdateSubscriptionRequest Entity for requesting that a subscription be updated. swagger:model UpdateSubscriptionRequest

func (*UpdateSubscriptionRequest) Validate 

func (m *UpdateSubscriptionRequest) Validate(formats strfmt.Registry) error

Validate validates this update subscription request

type Webhook 

type Webhook struct {

	// URL
	URL string `json:"URL,omitempty"`

	// consecutive failures
	ConsecutiveFailures int32 `json:"consecutiveFailures,omitempty"`

	// deleted
	Deleted *bool `json:"deleted,omitempty"`

	// id
	ID string `json:"id,omitempty"`

	// name
	Name string `json:"name,omitempty"`

	// verification ID
	VerificationID string `json:"verificationID,omitempty"`

	// verified
	Verified *bool `json:"verified,omitempty"`
}

Webhook webhook swagger:model Webhook

func (*Webhook) Validate 

func (m *Webhook) Validate(formats strfmt.Registry) error

Validate validates this webhook

type WebhookPagedMetadata 

type WebhookPagedMetadata struct {

	// {"description":"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.","verbs":["GET","PUT","POST"]}
	// Required: true
	CurrentOffset *int32 `json:"currentOffset"`

	// {"description":"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.","verbs":["GET","PUT","POST"]}
	// Required: true
	CurrentPage *int32 `json:"currentPage"`

	// {"description":"Number of milliseconds taken by API to calculate response.","verbs":["GET","PUT","POST"]}
	// Required: true
	ExecutionTime *int64 `json:"executionTime"`

	// {"description":"Paging parameter. URL fragment that can be used to fetch next page of results.","verbs":["GET","PUT","POST"]}
	// Required: true
	NextPage *string `json:"nextPage"`

	// {"default":10,"description":"Paging parameter. Describes how many records you requested.","verbs":["GET","PUT","POST"]}
	// Required: true
	RecordsRequested *int32 `json:"recordsRequested"`

	// {"description":"Describes how many records were returned by your query.","verbs":["GET","PUT","POST"]}
	// Required: true
	RecordsReturned *int32 `json:"recordsReturned"`

	// {"description":"The results returned by your query.","verbs":["GET","PUT","POST"]}
	// Required: true
	Results []*Webhook `json:"results"`
}

WebhookPagedMetadata webhook paged metadata swagger:model WebhookPagedMetadata

func (*WebhookPagedMetadata) Validate 

func (m *WebhookPagedMetadata) Validate(formats strfmt.Registry) error

Validate validates this webhook paged metadata

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.