Overview

Classes

  • Syspay_Merchant_AstroPayBanksRequest
  • Syspay_Merchant_BillingAgreementCancellationRequest
  • Syspay_Merchant_BillingAgreementInfoRequest
  • Syspay_Merchant_BillingAgreementListRequest
  • Syspay_Merchant_BillingAgreementRequest
  • Syspay_Merchant_ChargebackInfoRequest
  • Syspay_Merchant_ChargebackListRequest
  • Syspay_Merchant_Client
  • Syspay_Merchant_ConfirmRequest
  • Syspay_Merchant_EMS
  • Syspay_Merchant_Entity
  • Syspay_Merchant_Entity_AstroPayBank
  • Syspay_Merchant_Entity_BillingAgreement
  • Syspay_Merchant_Entity_Chargeback
  • Syspay_Merchant_Entity_Creditcard
  • Syspay_Merchant_Entity_Customer
  • Syspay_Merchant_Entity_Eterminal
  • Syspay_Merchant_Entity_Payment
  • Syspay_Merchant_Entity_PaymentMethod
  • Syspay_Merchant_Entity_PaymentRecipient
  • Syspay_Merchant_Entity_Plan
  • Syspay_Merchant_Entity_Refund
  • Syspay_Merchant_Entity_Subscription
  • Syspay_Merchant_Entity_SubscriptionEvent
  • Syspay_Merchant_EterminalRequest
  • Syspay_Merchant_IpAddressesRequest
  • Syspay_Merchant_PaymentInfoRequest
  • Syspay_Merchant_PaymentListRequest
  • Syspay_Merchant_PaymentRequest
  • Syspay_Merchant_PlanInfoRequest
  • Syspay_Merchant_PlanRequest
  • Syspay_Merchant_PlanUpdateRequest
  • Syspay_Merchant_RebillRequest
  • Syspay_Merchant_Redirect
  • Syspay_Merchant_RefundInfoRequest
  • Syspay_Merchant_RefundListRequest
  • Syspay_Merchant_RefundRequest
  • Syspay_Merchant_Request
  • Syspay_Merchant_SubscriptionCancellationRequest
  • Syspay_Merchant_SubscriptionInfoRequest
  • Syspay_Merchant_SubscriptionRebillRequest
  • Syspay_Merchant_SubscriptionRequest
  • Syspay_Merchant_Utils
  • Syspay_Merchant_VoidRequest

Interfaces

  • Syspay_Merchant_Entity_ReturnedEntityInterface

Exceptions

  • Syspay_Merchant_EMSException
  • Syspay_Merchant_RedirectException
  • Syspay_Merchant_RequestException
  • Syspay_Merchant_UnexpectedResponseException
  • Overview
  • Class
  • Tree

Class Syspay_Merchant_SubscriptionCancellationRequest

Cancel a subscription

Syspay_Merchant_Request
Extended by Syspay_Merchant_SubscriptionCancellationRequest
See: https://app.syspay.com/docs/api/merchant_subscription.html#cancelling-a-subscription
Located at Syspay/SDK/Merchant/Request/SubscriptionCancellation.php
Methods summary
public
# __construct( mixed $subscriptionId = null )
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 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 integer
# getSubscriptionId( )

Gets the value of subscriptionId.

Gets the value of subscriptionId.

Returns

integer
integer
public Syspay_Merchant_SubscriptionCancellationRequest
# setSubscriptionId( integer $subscriptionId )

Sets the value of subscriptionId.

Sets the value of subscriptionId.

Parameters

$subscriptionId
the subscription id

Returns

Syspay_Merchant_SubscriptionCancellationRequest
self
public Syspay_Merchant_SubscriptionCancellationRequest
# setNow( boolean $now )

Sets the value of now.

Sets the value of now.

Parameters

$now
Terminate the subscription right away

Returns

Syspay_Merchant_SubscriptionCancellationRequest
self
public boolean
# getNow( )

Gets the value of now.

Gets the value of now.

Returns

boolean
boolean
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()
Constants summary
string METHOD
#'POST'
string PATH
#'/api/v1/merchant/subscription/%d/cancel'
Syspay Merchant SDK API documentation generated by ApiGen 2.8.0