Class Syspay_Merchant_SubscriptionRequest

Process a subscription

Syspay_Merchant_SubscriptionRequest

See: https://app.syspay.com/docs/api/merchant_subscription.html#subscribe-a-customer-to-a-plan-hosted-flow
See: https://app.syspay.com/docs/api/merchant_subscription.html#subscribe-a-customer-to-a-plan-server-2-server-flow
See: https://app.syspay.com/docs/api/merchant_subscription.html#subscribe-a-customer-to-a-plan-by-re-using-an-existing-subscription-or-billing-agreement
Located at Syspay/SDK/Merchant/Request/Subscription.php

Methods summary
`public string`	# `getMethod( )` Get the HTTP method to use to make the request Get the HTTP method to use to make the request Returns `string` HTTP method
`public string`	# `getPath( )` Get the path to call to make the request Get the path to call to make the request Returns `string` API path
`public array`	# `getData( )` Get the data to send to the API for the request Get the data to send to the API for the request Returns `array` An array of data that will be json-encoded by the Syspay_Merchant_Client Overrides `Syspay_Merchant_Request::getData()`
`public mixed`	# `buildResponse( stdClass $response )` Build an object based on the decoded response received from the API (turned to a stdClass object) Build an object based on the decoded response received from the API (turned to a stdClass object) Parameters `$response` The data to build the object from Returns `mixed` The object built
`public Syspay_Merchant_Entity_Subscription`	# `getSubscription( )` Gets the value of subscription. Gets the value of subscription. Returns `Syspay_Merchant_Entity_Subscription` Syspay_Merchant_Entity_Subscription
`public Syspay_Merchant_SubscriptionRequest`	# `setSubscription( Syspay_Merchant_Entity_Subscription $subscription )` Sets the value of subscription. Sets the value of subscription. Parameters `$subscription` the subscription Returns `Syspay_Merchant_SubscriptionRequest` self
`public string`	# `getFlow( )` Gets the value of flow. Gets the value of flow. Returns `string` string
`public Syspay_Merchant_SubscriptionRequest`	# `setFlow( string $flow )` Sets the value of flow. Sets the value of flow. Parameters `$flow` the flow Returns `Syspay_Merchant_SubscriptionRequest` self
`public Syspay_Merchant_Entity_Customer`	# `getCustomer( )` Gets the value of customer. Gets the value of customer. Returns `Syspay_Merchant_Entity_Customer` Syspay_Merchant_Entity_Customer
`public Syspay_Merchant_SubscriptionRequest`	# `setCustomer( Syspay_Merchant_Entity_Customer $customer )` Sets the value of customer. Sets the value of customer. Parameters `$customer` the customer Returns `Syspay_Merchant_SubscriptionRequest` self
`public string`	# `getPaymentMethod( )` Gets the value of paymentMethod. Gets the value of paymentMethod. Returns `string` string
`public Syspay_Merchant_SubscriptionRequest`	# `setPaymentMethod( string $paymentMethod )` Sets the value of paymentMethod. Sets the value of paymentMethod. Parameters `$paymentMethod` the payment method Returns `Syspay_Merchant_SubscriptionRequest` self
`public string`	# `getThreatMetrixSessionId( )` Gets the value of threatMetrixSessionId. Gets the value of threatMetrixSessionId. Returns `string` string
`public Syspay_Merchant_SubscriptionRequest`	# `setThreatMetrixSessionId( string $threatMetrixSessionId )` Sets the value of threatMetrixSessionId. Sets the value of threatMetrixSessionId. Parameters `$threatMetrixSessionId` the threat metrix session id Returns `Syspay_Merchant_SubscriptionRequest` self
`public Syspay_Merchant_Entity_Creditcard`	# `getCreditcard( )` Gets the value of creditcard. Gets the value of creditcard. Returns `Syspay_Merchant_Entity_Creditcard` Syspay_Merchant_Entity_Creditcard
`public Syspay_Merchant_SubscriptionRequest`	# `setCreditcard( Syspay_Merchant_Entity_Creditcard $creditcard )` Sets the value of creditcard. Sets the value of creditcard. Parameters `$creditcard` the creditcard Returns `Syspay_Merchant_SubscriptionRequest` self
`public integer`	# `getUseSubscription( )` Gets the value of useSubscription. Gets the value of useSubscription. Returns `integer` integer
`public Syspay_Merchant_SubscriptionRequest`	# `setUseSubscription( integer $useSubscription )` Sets the value of useSubscription. Sets the value of useSubscription. Parameters `$useSubscription` the use subscription Returns `Syspay_Merchant_SubscriptionRequest` self
`public integer`	# `getUseBillingAgreement( )` Gets the value of useBillingAgreement. Gets the value of useBillingAgreement. Returns `integer` integer
`public Syspay_Merchant_SubscriptionRequest`	# `setUseBillingAgreement( integer $useBillingAgreement )` Sets the value of useBillingAgreement. Sets the value of useBillingAgreement. Parameters `$useBillingAgreement` the use billing agreement Returns `Syspay_Merchant_SubscriptionRequest` self

Constants summary
`string`	`FLOW_API`	#`'API'`
`string`	`FLOW_BUYER`	#`'BUYER'`
`string`	`FLOW_SELLER`	#`'SELLER'`
`string`	`METHOD`	#`'POST'`
`string`	`PATH`	#`'/api/v1/merchant/subscription'`

Classes

Interfaces

Exceptions

Class Syspay_Merchant_SubscriptionRequest

Returns

Returns

Returns

Overrides

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns